POST
/
catalogue
/
products

Authorizations

Authorization
string
headerrequired

Value for the Authorization header parameter.

Body

productFamilies
object[]
required

A product family groups multiple products together.

number
string | null
required

Internal product number

Required string length: 2 - 255
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.

name
string

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

description
string | null

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

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.

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

The cost centre is used for accounting exports.

createdAt
string
updatedAt
string
taxGroup
object

The tax group that is used for the product.

isArchived
boolean

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

Response

201 - application/json
productFamilies
object[]
required

A product family groups multiple products together.

number
string | null
required

Internal product number

Required string length: 2 - 255
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.

id
string

The unique identifier of the product.

name
string

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

description
string | null

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

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.

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

The cost centre is used for accounting exports.

createdAt
string
updatedAt
string
taxGroup
object

The tax group that is used for the product.

isArchived
boolean

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

Was this page helpful?

Get productsGet a product