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
Accounting
Create a checkout link
Create a link to allow your customers to checkout the given line items.
Required permissions:checkout-link:writeAuthorizations
Value for the Authorization header parameter.
Body
The action to perform after checkout.
The action to perform after checkout.
redirect, confirmation_message The url of the button "Zurück zum Anbieter". If none is provided, the button is hidden.
255The confirmation message to display after checkout. If none is set, the default confirmation message will be used.
255The url to redirect to after checkout. This is required for action "redirect".
255Whether the checkout link is enabled or not.
The contract period terms of the product item. If none provided, the billing period will be used as contract period, the cancellation period is set to 1 day.
This is required when the type is "plan".
This is required when the type is "product", "plan".
This is required when the type is "product".
This is required when the type is "product".
The type of the checkout link item.
Possible values:
product: A product will be added to the cart, with the given quantity.plan: A plan will be added to the cart, and can be configured by the customer.
The options for the checkout link.
Whether coupons can be applied to the checkout link or not.
Whether the company should be forced in the checkout form or not.
Whether the quantity of the item can be edited or not.
The number of days as trial period. If a price has the flag "applyTrial" set to false, the price will be charged immediately.
Response
The action to perform after checkout.
The action to perform after checkout.
redirect, confirmation_message The url of the button "Zurück zum Anbieter". If none is provided, the button is hidden.
255The confirmation message to display after checkout. If none is set, the default confirmation message will be used.
255The url to redirect to after checkout. This is required for action "redirect".
255The unique identifier of the checkout link.
Whether the checkout link is enabled or not.
This is required when the type is "plan".
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 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 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.
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 The name of the product based on the current tenant language. This will be displayed on customer communication.
The 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.
This is required when the type is "product", "plan".
The currency of the price
The price in the defined billing interval.
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.
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.
The billing interval of the price plan. If null, this is a one-time charge. Billing intervals of null cannot be prorated.
The charge related to this price plan.
The checkout link IDs related to this price plan.
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.
The customer this price plan belongs to.
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.
The unique identifier of the price plan.
The internal name of the price plan.
3 - 255If this price plan is in use.
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.
The product this price plan belongs to.
The product set option related to this price plan.
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.
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.
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)
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.
This is required when the type is "product".
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 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.
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 The name of the product based on the current tenant language. This will be displayed on customer communication.
This is required when the type is "product".
The type of the checkout link item.
Possible values:
product: A product will be added to the cart, with the given quantity.plan: A plan will be added to the cart, and can be configured by the customer.
Whether coupons can be applied to the checkout link or not.
Whether the company should be forced in the checkout form or not.
Whether the quantity of the item can be edited or not.
The number of days as trial period. If a price has the flag "applyTrial" set to false, the price will be charged immediately.
The name of the checkout link.
The URL of the checkout link.
Was this page helpful?