Create a product

POST

catalogue

products

curl -X POST \
 /catalogue/products \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "productFamilies": [
        []
    ],
    "name": "Basic",
    "description": "For small teams.",
    "internalName": "Basic (Weekly)",
    "number": "M-1234",
    "translations": [],
    "type": "",
    "measurement": {
        "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
        "code": "users",
        "description": "The number of users.",
        "fairBilling": "1"
    },
    "invoiceVisibility": "",
    "createdAt": "",
    "updatedAt": "",
    "taxGroup": {
        "id": "00000000-0000-0000-0000-000000000000",
        "internalDescription": "19%"
    },
    "isArchived": "",
    "customFields": {
        "field1": "value1",
        "field2": "value2"
    }
}'

{
  "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
  "productFamilies": [
    {
      "id": "ad8b3b9e-5b0a-4e1a-8b0a-4e1a8b0a4e1a",
      "name": "Team Packages"
    }
  ],
  "name": "Basic",
  "description": "For small teams.",
  "internalName": "Basic (Weekly)",
  "number": "M-1234",
  "translations": {},
  "type": "product",
  "measurement": {
    "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "unit": {
      "id": {},
      "name": "Stück",
      "translations": {}
    },
    "code": "users",
    "description": "The number of users.",
    "aggregationType": "<any>",
    "fairBilling": true,
    "type": "<any>"
  },
  "invoiceVisibility": "always",
  "costCentre": {
    "id": "ad8f1c9c-4f0a-4e1a-8b1a-9c4d9c4d9c4d",
    "name": "Cost Centre",
    "code": "CC",
    "type": "KOST1",
    "createdAt": "2021-01-01T00:00:00+00:00",
    "updatedAt": "2021-01-01T00:00:00+00:00"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "taxGroup": {
    "id": "00000000-0000-0000-0000-000000000000",
    "internalDescription": "19%",
    "reverseChargeType": "REVERSE_CHARGE",
    "type": "standard"
  },
  "isArchived": true,
  "customFields": {
    "field1": "value1",
    "field2": "value2"
  }
}

Authorizations

Authorization

string

header

required

Value for the Authorization header parameter.

Body

The new Product resource

productFamilies

object[]

required

A product family groups multiple products together.

translations

object

required

The translations of the product. The locale is used as key.

type

enum<string>

required

The type of the product.

product: recurring billed product
charge: one-time billing
plan: plan specific product, which cannot be used as a normal product. Will be filtered out in any product lists.

Available options:

product,

charge,

plan

measurement

object

required

The measurement that is used for the price plan. This could define the quantity or a metered usage.

measurement.unit

object | null

required

The unit of the measurement.

measurement.code

string

required

A unique code which can be used to identify the measurement.

Required string length: 1 - 255

Example:

"users"

measurement.description

string | null

A description of the measurement, which is shown in the summary of the usage data in the invoice.

Maximum length: 255

Example:

"The number of users."

measurement.aggregationType

any

The aggregation type of the measurement. Describes how the quantity is calculated. This cannot be changed after creation, otherwise it would change the whole calculation for existing subscriptions.

Possible values:

count: The number of sent measurements in the billing interval. Metered usage, which resets to 0 after each billing interval.
count_unique: The number of unique sent measurements in the billing interval, identified by the id given on event creation.
max: The maximum value of all sent measurements in the billing interval. Metered usage, which resets to 0 after each billing interval.
sum: The sum of all sent measurements in the billing interval.
last_value: The last sent measurement.
average: The average of all sent measurements in the billing interval.

measurement.fairBilling

boolean

default:true

If set to false, the measurement will be billed for the whole billing interval, even if the quantity changes, or the item is cancelled / terminated during the billing interval.

Example:

true

measurement.type

any

The type of the measurement. This cannot be changed after creation, otherwise it would change the whole calculation for existing subscriptions.

Possible values:

instant_metered: The measurement value is reset to 0 after each push. The measurement gets billed immediately and an invoice is created. The aggregation type must be "last_value".
metered: The measurement value is reset to 0 after each billing interval.
recurring: The measurement value is not reset to 0 after each billing interval and the last value is used for all following billing intervals. The aggregation type must be "last_value".

taxGroup

object

required

The tax group that is used for the product.

name

string

The name of the product based on the current tenant language. This will be displayed on customer communication.

Example:

"Basic"

description

string | null

The description of the product based on the current tenant language.

Example:

"For small teams."

internalName

string | null

Internal name of the product, to differentiate between products with the same name. This will shown in web-app lists, selections and reports.

Example:

"Basic (Weekly)"

number

string | null

Internal product number

Required string length: 2 - 255

Example:

"M-1234"

invoiceVisibility

enum<string>

Defines when the product should be displayed in the invoice.

always: The product is always displayed in the invoice.
only_if_charged: The product is only displayed in the invoice if it is charged.

Available options:

always,

only_if_charged

costCentre

object | null

The cost centre is used for accounting exports.

createdAt

string

updatedAt

string

isArchived

boolean

Defines if the product is archived and should not be used anymore.

customFields

object | null

Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide

Example:

{ "field1": "value1", "field2": "value2" }

Response

201

application/json

Product resource created

productFamilies

object[]

required

A product family groups multiple products together.

translations

object

required

The translations of the product. The locale is used as key.

type

enum<string>

required

The type of the product.

product: recurring billed product
charge: one-time billing
plan: plan specific product, which cannot be used as a normal product. Will be filtered out in any product lists.

Available options:

product,

charge,

plan

measurement

object

required

The measurement that is used for the price plan. This could define the quantity or a metered usage.

measurement.unit

object | null

required

The unit of the measurement.

measurement.code

string

required

A unique code which can be used to identify the measurement.

Required string length: 1 - 255

Example:

"users"

measurement.id

string

A unique identifier for the measurement.

Example:

"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"

measurement.description

string | null

A description of the measurement, which is shown in the summary of the usage data in the invoice.

Maximum length: 255

Example:

"The number of users."

measurement.aggregationType

any

The aggregation type of the measurement. Describes how the quantity is calculated. This cannot be changed after creation, otherwise it would change the whole calculation for existing subscriptions.

Possible values:

count: The number of sent measurements in the billing interval. Metered usage, which resets to 0 after each billing interval.
count_unique: The number of unique sent measurements in the billing interval, identified by the id given on event creation.
max: The maximum value of all sent measurements in the billing interval. Metered usage, which resets to 0 after each billing interval.
sum: The sum of all sent measurements in the billing interval.
last_value: The last sent measurement.
average: The average of all sent measurements in the billing interval.

measurement.fairBilling

boolean

default:true

If set to false, the measurement will be billed for the whole billing interval, even if the quantity changes, or the item is cancelled / terminated during the billing interval.

Example:

true

measurement.type

any

The type of the measurement. This cannot be changed after creation, otherwise it would change the whole calculation for existing subscriptions.

Possible values:

instant_metered: The measurement value is reset to 0 after each push. The measurement gets billed immediately and an invoice is created. The aggregation type must be "last_value".
metered: The measurement value is reset to 0 after each billing interval.
recurring: The measurement value is not reset to 0 after each billing interval and the last value is used for all following billing intervals. The aggregation type must be "last_value".

taxGroup

object

required

The tax group that is used for the product.

string

The unique identifier of the product.

Example:

"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"

name

string

The name of the product based on the current tenant language. This will be displayed on customer communication.

Example:

"Basic"

description

string | null

The description of the product based on the current tenant language.

Example:

"For small teams."

internalName

string | null

Internal name of the product, to differentiate between products with the same name. This will shown in web-app lists, selections and reports.

Example:

"Basic (Weekly)"

number

string | null

Internal product number

Required string length: 2 - 255

Example:

"M-1234"

invoiceVisibility

enum<string>

Defines when the product should be displayed in the invoice.

always: The product is always displayed in the invoice.
only_if_charged: The product is only displayed in the invoice if it is charged.

Available options:

always,

only_if_charged

costCentre

object | null

The cost centre is used for accounting exports.

createdAt

string

updatedAt

string

isArchived

boolean

Defines if the product is archived and should not be used anymore.

customFields

object | null

Example:

{ "field1": "value1", "field2": "value2" }

Get products Get a product

curl -X POST \
 /catalogue/products \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "productFamilies": [
        []
    ],
    "name": "Basic",
    "description": "For small teams.",
    "internalName": "Basic (Weekly)",
    "number": "M-1234",
    "translations": [],
    "type": "",
    "measurement": {
        "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
        "code": "users",
        "description": "The number of users.",
        "fairBilling": "1"
    },
    "invoiceVisibility": "",
    "createdAt": "",
    "updatedAt": "",
    "taxGroup": {
        "id": "00000000-0000-0000-0000-000000000000",
        "internalDescription": "19%"
    },
    "isArchived": "",
    "customFields": {
        "field1": "value1",
        "field2": "value2"
    }
}'

{
  "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
  "productFamilies": [
    {
      "id": "ad8b3b9e-5b0a-4e1a-8b0a-4e1a8b0a4e1a",
      "name": "Team Packages"
    }
  ],
  "name": "Basic",
  "description": "For small teams.",
  "internalName": "Basic (Weekly)",
  "number": "M-1234",
  "translations": {},
  "type": "product",
  "measurement": {
    "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "unit": {
      "id": {},
      "name": "Stück",
      "translations": {}
    },
    "code": "users",
    "description": "The number of users.",
    "aggregationType": "<any>",
    "fairBilling": true,
    "type": "<any>"
  },
  "invoiceVisibility": "always",
  "costCentre": {
    "id": "ad8f1c9c-4f0a-4e1a-8b1a-9c4d9c4d9c4d",
    "name": "Cost Centre",
    "code": "CC",
    "type": "KOST1",
    "createdAt": "2021-01-01T00:00:00+00:00",
    "updatedAt": "2021-01-01T00:00:00+00:00"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "taxGroup": {
    "id": "00000000-0000-0000-0000-000000000000",
    "internalDescription": "19%",
    "reverseChargeType": "REVERSE_CHARGE",
    "type": "standard"
  },
  "isArchived": true,
  "customFields": {
    "field1": "value1",
    "field2": "value2"
  }
}

API documentation

User

Tenant

Feature

Entitlement

User & permissions

Settings

Payment

Analytics

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Authorizations

Body

Response