API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
- Settings
- Media
- Webhook
- Notification
Payment
- Payment Method
- Transaction
- SEPA XML
- Open Banking
- Bank Account Transaction
Customer
- Customer
- Customer Address
- Customer Email
- Customer Settings
- Customer Otp
Billing
- Invoice
- Invoice Position Item
- Billing Run
Dunning
- Dunning Document
- Dunning Rule
Subscription
- Subscription
- Subscription Item
- Subscription Measurement
- Billing Group
Offers
- Offer
- Offer Recipient
- Offer Template
Catalogue
- Unit
- Measurement
- Product
- Product Family
- Price Plan
- Coupon
Checkout
- Checkout Link
- Cart
Accounting
Get products
Get products
Required permissions:product:readAuthorizations
Value for the Authorization header parameter.
Query Parameters
Defines the locale to use for translations. Defaults to tenant locale.
Defines if archived products should be included in the result.
The collection page number
The number of items per page
0 < x < 100translations Response
The measurement that is used for the price plan. This could define the quantity or a metered usage.
A unique code which can be used to identify the measurement.
1 - 255The 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.
A description of the measurement, which is shown in the summary of the usage data in the invoice.
255If 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.
A unique identifier for the measurement.
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".
The tax group that is used for the product.
The name of the tax group which will be displayed only in the UI
255Defines if reverse charge will be applicated or not
REVERSE_CHARGE_DEACTIVATED, REVERSE_CHARGE, REVERSE_CHARGE_INTRA_EU_SUPPLY standard, reduced The type of the product.
product: recurring billed productcharge: one-time billingplan: plan specific product, which cannot be used as a normal product. Will be filtered out in any product lists.
product, charge, plan The cost centre is used for accounting exports.
The name of the cost centre, which is displayed in the UI
255The type of the cost centre, which is used for exports
KOST1, KOST2 The code of the cost centre, which is used for exports
The date and time when the cost centre was created
The date and time when the cost centre was last updated
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
The description of the product based on the current tenant language.
The unique identifier of the product.
Internal name of the product, to differentiate between products with the same name. This will shown in web-app lists, selections and reports.
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.
always, only_if_charged Defines if the product is archived and should not be used anymore.
The name of the product based on the current tenant language. This will be displayed on customer communication.
Internal product number
2 - 255Was this page helpful?