Zum Hauptinhalt springen
GET
cURL

Autorisierungen

Authorization
string
header
erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Pfadparameter

id
string
erforderlich

Product identifier

Antwort

Product resource

productFamilies
object[]
erforderlich

A product family groups multiple products together.

translations
object
erforderlich

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

type
enum<string>
erforderlich

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.
Verfügbare Optionen:
product,
charge,
plan
measurement
object
erforderlich

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

taxGroup
object
erforderlich

The tax group that is used for the product.

id
string
read-only

The unique identifier of the product.

Beispiel:

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

Beispiel:

"Basic"

description
string | null

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

Beispiel:

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

Beispiel:

"Basic (Weekly)"

number
string | null

Internal product number

Required string length: 2 - 255
Beispiel:

"M-1234"

pricePlans
object[]

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

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.
Verfügbare Optionen:
always,
only_if_charged
costCentre
object | null

The cost centre is used for accounting exports.

createdAt
string<date-time>
updatedAt
string<date-time>
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

Beispiel: