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
Create a coupon
You can create a coupon, which can be used by customers to get a discount on their subscription. You can create a coupon with a fixed amount or a percentage. You can also set a maximum number of uses and a maximum number of uses per customer. You can also set an end date, after which the coupon is no longer valid.
The coupon code can be used in the checkout process, in the customer front, or via the API.
Required permissions:coupon:writeAuthorizations
Value for the Authorization header parameter.
Body
The code that can be used to apply this coupon or to use it with the api.
The frequency at which a coupon should be applied.
Possible values:
once: The coupon will be applied once for the first billing period.limited: The coupon will be applied for a limited number of billing periods.lifetime: The coupon will be applied forever.
The name of this coupon, which will be displayed to the user in the checkout process, customer front, etc.
The type of this coupon.
Possible values:
percentage: A percentage will be taken off the total plan amount.fixed_amount: A fixed amount will be taken off the total plan amount. It will never go below 0.
The plans this coupon should not be applied to.
The products this coupon should not be applied to.
The date and time this coupon will expire. If null, there is no expiration date.
The fixed amount this coupon should apply. Required for type fixed_amount.
The number of billing periods the coupon will be applied for. Required for frequency limited.
Whether this coupon is enabled or not.
The plans this coupon should be applied to.
The products this coupon should be applied to.
The number of times this coupon can be redeemed in total. If null, there is no limit.
The number of times this coupon can be redeemed by a customer. If null, there is no limit.
The percentage this coupon should apply. Required for type percentage.
0 < x < 100Response
The code that can be used to apply this coupon or to use it with the api.
The frequency at which a coupon should be applied.
Possible values:
once: The coupon will be applied once for the first billing period.limited: The coupon will be applied for a limited number of billing periods.lifetime: The coupon will be applied forever.
The name of this coupon, which will be displayed to the user in the checkout process, customer front, etc.
The type of this coupon.
Possible values:
percentage: A percentage will be taken off the total plan amount.fixed_amount: A fixed amount will be taken off the total plan amount. It will never go below 0.
The date and time when the resource was created.
The plans this coupon should not be applied to.
Allow to checkout this plan. If this is set to false, the plan will not be available in the checkout and can only be assigned to a subscription by the API or in the admin panel. The plan.code is a part of the checkout url.
The code of the plan. This is used to identify the plan e.g. in the checkout url.
The description of this plan
Allow to group plans together. This allows to upgrade or downgrade between plans in the same family.
The unique identifier of the plan.
The name of this plan
The origin product this plan belongs to. This is relevant for advanced analytics.
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 unit of the measurement.
The date and time when the resource was created.
The date and time when the resource was last updated.
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.
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".
A product family groups multiple products together.
255The date and time when the resource was created.
The date and time when the resource was last updated.
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 - 255The status of the plan.
Possible values:
draft: The plan is a draft and not available for usage in a subscription.active: The plan is active and can be used in a subscription.archived: The plan is archived and not longer available for usage in a subscription.inactive: The plan is inactive and not available for usage in a subscription.
The products this coupon should not be applied to.
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 unit of the measurement.
The date and time when the resource was created.
The date and time when the resource was last updated.
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.
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".
A product family groups multiple products together.
255The date and time when the resource was created.
The date and time when the resource was last updated.
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 - 255The date and time this coupon will expire. If null, there is no expiration date.
The fixed amount this coupon should apply. Required for type fixed_amount.
The number of billing periods the coupon will be applied for. Required for frequency limited.
The id of this coupon.
Whether this coupon is enabled or not.
The plans this coupon should be applied to.
Allow to checkout this plan. If this is set to false, the plan will not be available in the checkout and can only be assigned to a subscription by the API or in the admin panel. The plan.code is a part of the checkout url.
The code of the plan. This is used to identify the plan e.g. in the checkout url.
The description of this plan
Allow to group plans together. This allows to upgrade or downgrade between plans in the same family.
The unique identifier of the plan.
The name of this plan
The origin product this plan belongs to. This is relevant for advanced analytics.
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 unit of the measurement.
The date and time when the resource was created.
The date and time when the resource was last updated.
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.
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".
A product family groups multiple products together.
255The date and time when the resource was created.
The date and time when the resource was last updated.
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 - 255The status of the plan.
Possible values:
draft: The plan is a draft and not available for usage in a subscription.active: The plan is active and can be used in a subscription.archived: The plan is archived and not longer available for usage in a subscription.inactive: The plan is inactive and not available for usage in a subscription.
The products this coupon should be applied to.
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 unit of the measurement.
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.
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".
A product family groups multiple products together.
255The date and time when the resource was created.
The date and time when the resource was last updated.
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 - 255The number of times this coupon can be redeemed in total. If null, there is no limit.
The number of times this coupon can be redeemed by a customer. If null, there is no limit.
The percentage this coupon should apply. Required for type percentage.
0 < x < 100Has this coupon been redeemed by a customer? If yes, it cannot be edited or deleted anymore.
The date and time when the resource was last updated.
Was this page helpful?