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
- GETGet all subscriptions
- POSTCreate subscription
- POSTCreate subscription from plan
- GETGet subscription
- PUTUpdate subscription
- DELDelete subscription
- PUTActivate subscription
- GETGet estimated amount
- GETGet estimated invoice
- PUTExtend trial
- PUTUpdate invoice address
- PUTPause subscription
- PUTUpdate payment method
- POSTOrder products
- PUTResume subscription
- PUTRevoke trial
- PUTCancel subscription
- POSTAdd comment
- GET
- 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 all subscriptions
Get all subscriptions as a list.
Required permissions:subscription:readAuthorizations
Value for the Authorization header parameter.
Query Parameters
The collection page number
The number of items per page
0 < x < 100asc, desc asc, desc asc, desc asc, desc asc, desc Response
The date the subscription was activated.
The billing group defines the billing cycle of the subscription.
The date the subscription will be cancelled.
The date when the subscription was cancelled.
The date and time when the resource was created.
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
The invoice address is null, we use the default invoice address of the customer.
The payment method is null, we use the default payment method of the customer.
The invoice address of the subscription. If null, the default invoice address of the customer is used.
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.
Indicates if the subscription is pending for cancellation. If true, the subscription will be cancelled in the future and the cancellation could be revoked.
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 payment method of the subscription. If null, the default payment method of the customer is used.
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 The plan this subscription is based on.
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.
Define the behaviour when a plan change will be applied. If null the default behaviour will be used.
immediately, end_of_period Define the allowed actions after subscription by customer, for upgrade / downgrade.
upgradeable, downgradeable, upgradeable_and_downgradeable, not_changeable The code of the plan. This is used to identify the plan e.g. in the checkout url.
The description of this plan
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 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 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.
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 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.
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 date and time when the resource was last updated.
Was this page helpful?