Get a product

GET

catalogue

products

{id}

curl -X GET \
 /catalogue/products/{id} \
 --header "Authorization: Bearer <token>"

{
  "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>"
  },
  "pricePlans": [
    {
      "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "internalName": "Exclusive pricing for partners.",
      "status": "<any>",
      "salesChannel": {},
      "type": "<any>",
      "applyTrial": true,
      "payInAdvance": true,
      "proRata": true,
      "freeUnits": {},
      "billingInterval": "1M",
      "showPricePerInterval": "1M",
      "currencyCode": {},
      "price": {
        "amount": 123,
        "createdAt": "2021-01-01T00:00:00+00:00",
        "updatedAt": "2021-01-01T00:00:00+00:00",
        "tenantId": "<string>"
      },
      "custom": true,
      "charge": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "productSetOption": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "product": "<any>",
      "customer": "<any>",
      "inUse": true,
      "checkoutLinkIds": [
        "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"
      ]
    }
  ],
  "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.

Path Parameters

string

required

Product identifier

Response

200

application/json

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.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"

pricePlans

object[]

The price plans of the product. Describes multiple prices which could be selled by this product.

pricePlans.type

any

required

The type of the charge. This defines how the price is calculated.

Possible values:

flat_fee: A flat fee is charged, e.g. 10€ per month independent of the number of units.
volume: A volume based price is charged, e.g. 10€ for the first 10 units and 9€ for all units when the number of units is above 10. Useful for volume discounts.
percentage: A percentage of the total price is charged, e.g. 10% of the total price multiplied by the number of units. Useful for provisions.
per_unit: A price per unit is charged, e.g. 10€ per unit per billing interval. Useful for per seat based pricing.
tiered: A tiered price is charged. E.g. 10€ per unit for the first 10 units, 9€ per unit for the next 10 units and 8€ per unit for all units above 20.
stair_step: A stair step price is charged. E.g. 10€ per unit for the first 10 units, 9€ per unit for all units above 10.

pricePlans.currencyCode

object

required

The currency of the price

pricePlans.price

object

required

The price in the defined billing interval.

pricePlans.id

string

The unique identifier of the price plan.

Example:

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

pricePlans.internalName

string | null

The internal name of the price plan.

Required string length: 3 - 255

Example:

"Exclusive pricing for partners."

pricePlans.status

any

The status of the price plan.

Possible values:

active: The price is active and can be used.
archived: The price is archived and cannot be used anymore. It will be not shown in any lists until explicitly requested.

pricePlans.salesChannel

object | null

This price is only available for a specific sales channel. If this is set, the price is only available for the sales channel with the given ID. All other price plans will be ignored.

pricePlans.applyTrial

boolean

default:true

If this is set to true, the price plan can be applied on a trial. If the product is in trial, and this is false, the price will be charged on subscription start, otherwise after trial.

Example:

true

pricePlans.payInAdvance

boolean | null

default:true

If this is set to true, the price will be charged in advance. If this is false, the price will be charged at the end of the billing interval.

Example:

true

pricePlans.proRata

boolean

If this is set to true, the price will be charged prorated when a partial billing interval is billed. This applies to measurements of type "recurring" or non-one-time billing intervals. For other measurements this parameter will be ignored.

pricePlans.freeUnits

object | null

The amount of free units. If null, no free units are available. Free units will be applied before passed to the price calculation and are available prorated. If the customer does not uses the free units during a billing period, they are not carried over to the next billing period. If the customer cancels the subscription before ending the billing period, the free units are only available prorated for the remaining billing period.

Example: You offer 2400 free units for 12 months and your price has a billing interval for 1 month. The customer cancels after 6 months. Only 1200 free units are available.

A price plan for a recurring product cannot have free units. Use a metered product instead.

A price plan related to a product of type charge cannot have free units.

pricePlans.billingInterval

object | null

The billing interval of the price plan. If null, this is a one-time charge. Billing intervals of null cannot be prorated.

Example:

"1M"

pricePlans.showPricePerInterval

object | null

Display the billed price per interval in customerfront or invoices. If null, the price will be shown per billing interval. Currently only available for billing intervals of months, years. Currently only allowed to show price per month (1M)

Example:

"1M"

pricePlans.custom

boolean

If this price plan is a custom price plan. A price plan is custom if it is defined specific for a plan addon, plan charge, customer or sales channel.

Example:

true

pricePlans.charge

string

The charge related to this price plan.

Example:

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

pricePlans.productSetOption

string

The product set option related to this price plan.

Example:

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

pricePlans.product

any

The product this price plan belongs to.

pricePlans.customer

any

The customer this price plan belongs to.

pricePlans.inUse

boolean

If this price plan is in use.

Example:

true

pricePlans.checkoutLinkIds

string[]

The checkout link IDs related to this price plan.

Example:

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

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" }

Was this page helpful?

Suggest edits Raise issue

Create a product Update a product

curl -X GET \
 /catalogue/products/{id} \
 --header "Authorization: Bearer <token>"

{
  "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>"
  },
  "pricePlans": [
    {
      "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "internalName": "Exclusive pricing for partners.",
      "status": "<any>",
      "salesChannel": {},
      "type": "<any>",
      "applyTrial": true,
      "payInAdvance": true,
      "proRata": true,
      "freeUnits": {},
      "billingInterval": "1M",
      "showPricePerInterval": "1M",
      "currencyCode": {},
      "price": {
        "amount": 123,
        "createdAt": "2021-01-01T00:00:00+00:00",
        "updatedAt": "2021-01-01T00:00:00+00:00",
        "tenantId": "<string>"
      },
      "custom": true,
      "charge": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "productSetOption": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "product": "<any>",
      "customer": "<any>",
      "inUse": true,
      "checkoutLinkIds": [
        "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"
      ]
    }
  ],
  "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

Path Parameters

Response