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
- GETRetrieves completed carts of the current tenant.
- GETRetrieves a cart by its ID.
- GETRetrieves a cart by its ID.
- PUTChanges the quantity of a cart item.
- PUTConfirms a cart.
- PUTConfirms the OTP of a cart.
- GETRetrieves the invoice addresses of a cart.
- GETRetrieves the payment methods of a cart.
- PUTPrepares a cart for stripe.
- GET
Accounting
Retrieves a cart by its ID.
Retrieves a cart by its ID.
Required permissions:cart:readAuthorizations
Value for the Authorization header parameter.
Path Parameters
Cart identifier
Response
The customer who owns the cart.
2 - 255Can be empty. In this case the default currency of the tenant is used.
2 - 255The ID of the customer in DATEV
2 - 255Can be empty if the customer is a company.
2 - 255Can be empty if the customer is a company.
2 - 255STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_SUSPENDED The invoice of the cart. If the cart total amount is zero, no invoice will be created.
The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.
The customer of the invoice.
2 - 255Can be empty. In this case the default currency of the tenant is used.
2 - 255The ID of the customer in DATEV
2 - 255Can be empty if the customer is a company.
2 - 255Can be empty if the customer is a company.
2 - 255STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_SUSPENDED 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
reminder, dunning, none The unique identifier of the invoice.
The notice of the invoice.
The invoice address of the invoice.
The net amount of the invoice.
The document id of the invoice. This will be generated, when the invoice will be finalized.
The payment method which should be used to fullfill the payment of the invoice.
The card data of the payment method, if the type is "card"
The brand of the card
The card holder name
The expiration month of the card
The expiration year of the card
The last 4 digits of the card
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing The sepa mandate data of the payment method, if the type is "sepa_debit"
The bic of the sepa mandate
The iban of the sepa mandate
The mandate reference of the sepa mandate
The signing date of the sepa mandate
active, action_required, expired, revoked, gateway_unconfigured sepa_debit, card, paypal, bank_transfer, wallet, fake_provider STATUS_DRAFT, STATUS_PAID, STATUS_CANCELLED, STATUS_CLOSED, STATUS_REFUNDED, STATUS_REMINDED, STATUS_UNPAID, STATUS_NEW, STATUS_FINALIZING The type of the invoice.
TYPE_INVOICE, TYPE_CREDIT, TYPE_REFUND, TYPE_REMINDER, TYPE_CANCEL, TYPE_DUNNING Additional address information, which will be shown on generated documents like invoices, reminders, etc.
Company name, which will be used to bill to.
Cost centre, which will be shown on generated documents like invoices, reminders, etc.
First name, which will be shown on generated documents like invoices, reminders, etc.
Last name, which will be shown on generated documents like invoices, reminders, etc.
Firma, Herr, Frau active, archived TYPE_DEFAULT, TYPE_INVOICE VAT ID, which will be used to bill to. If not provided, we will use the customer vat id.
The items of the cart.
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 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.
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.
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.
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 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.
product A collection of key-value pairs that can be linked to an object. This feature is beneficial for storing extra details regarding the object in an organized manner. To remove all keys, simply submit an empty value to the metadata.
The payment method which should be used for the cart.
The card data of the payment method, if the type is "card"
The brand of the card
The card holder name
The expiration month of the card
The expiration year of the card
The last 4 digits of the card
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing The sepa mandate data of the payment method, if the type is "sepa_debit"
active, action_required, expired, revoked, gateway_unconfigured sepa_debit, card, paypal, bank_transfer, wallet, fake_provider The status of the cart.
Possible values:
open: The cart is open and can be edited.confirming: The cart is confirming and cannot be edited.
The subscription of the cart. If the cart has no recurring items (has only one-time fees), no subscription will be created.
The date the subscription was activated.
The billing group defines the billing cycle of the subscription.
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 last billing date of the subscription.
The name of the subscription. Defaults to the name of the plan. This will be used in the invoice for the grouping headers.
The next billing date of the subscription.
The number of the subscription.
The po number of the subscription.
The status of the subscription.
Possible values:
draft: The subscription is in draft mode and not active yet.active: The subscription is active and will be billed.paused: The subscription is paused and will not be billed.cancelled: The subscription is cancelled and will not be billed anymore.terminated: The subscription is terminated and will not be billed anymore.offer: The subscription is an offer and waiting for acceptance.
The date the trial period ends.
The transactions of the cart.
The original amount which was requested.
The amount which was charged to the payment method.
The date when the transaction was created.
The currency code of the transaction.
The description of the transaction.
The internal reference number of the transaction.
The amount of the transaction fee.
The date when the transaction was charged.
The amount which was refunded.
The status of the transaction.
Possible values:
new: The transaction is new and not yet processed. A new transaction is created when a payment is initiated.authorized: The transaction is authorized and can be captured.authorizing: The transaction is authorizing. No actions can be performed on the transaction.waiting: The transaction is waiting for a response from the payment provider, or a customer input. No actions can be performed on the transaction.offsite_authorization_required: The transaction requires an offsite authorization, e.g. 3D Secure. The customer is informed about the required authorization and redirected to the payment provider.booked: The transaction is captured and booked on the account.captured: The transaction is captured and will be booked on the account.dispute: The transaction is disputed.manual: Legacy status. Do not use.canceled: The transaction is canceled, e.g. by the customer during the payment process, or by the merchant.pending: The transaction is pending, and will be processed soon by the payment provider.expired: The transaction is expired, e.g. because the customer did not complete the payment process in time.processing: The transaction is processing, e.g. because the payment provider is currently processing the payment.failed: The transaction failed, e.g. because the payment provider could not process the payment.unknown: The transaction status is unknown.refunded: The transaction is fully refunded.payedout: The transaction was a payout.partial_refunded: The transaction is partially refunded.refund_failed: The transaction refund failed.
payment, refund Was this page helpful?