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 the invoice addresses of a cart.
Retrieves the invoice addresses of a cart.
curl -X GET \
/public/checkout/cart/{id}/invoice-addresses \
--header "Authorization: Bearer <token>"{
"data": [
{
"id": "<string>",
"vatId": "DE123456789",
"type": "TYPE_DEFAULT",
"default": "true",
"status": "active",
"city": "Berlin",
"zip": "12345",
"street": "Musterstraße",
"houseNumber": "1a",
"countryCode": "DE",
"companyName": "ACME Inc.",
"salutation": "Herr",
"addition": "c/o John Doe",
"costCentre": "123456789",
"firstName": "John",
"lastName": "Doe"
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}Authorizations
Value for the Authorization header parameter.
Path Parameters
Cart identifier
Query Parameters
The collection page number
The number of items per page
0 <= x <= 100Response
VAT ID, which will be used to bill to. If not provided, we will use the customer vat id.
"DE123456789"
TYPE_DEFAULT, TYPE_INVOICE "TYPE_DEFAULT"
"true"
active, archived "active"
"Berlin"
"12345"
"Musterstraße"
"1a"
"DE"
Company name, which will be used to bill to.
"ACME Inc."
Firma, Herr, Frau "Herr"
Additional address information, which will be shown on generated documents like invoices, reminders, etc.
"c/o John Doe"
Cost centre, which will be shown on generated documents like invoices, reminders, etc.
"123456789"
First name, which will be shown on generated documents like invoices, reminders, etc.
"John"
Last name, which will be shown on generated documents like invoices, reminders, etc.
"Doe"
curl -X GET \
/public/checkout/cart/{id}/invoice-addresses \
--header "Authorization: Bearer <token>"{
"data": [
{
"id": "<string>",
"vatId": "DE123456789",
"type": "TYPE_DEFAULT",
"default": "true",
"status": "active",
"city": "Berlin",
"zip": "12345",
"street": "Musterstraße",
"houseNumber": "1a",
"countryCode": "DE",
"companyName": "ACME Inc.",
"salutation": "Herr",
"addition": "c/o John Doe",
"costCentre": "123456789",
"firstName": "John",
"lastName": "Doe"
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}