API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
Payment
Customer
Dunning
Subscription
Offers
Catalogue
Checkout
curl -X GET \
/invoices/{invoiceId}/billing-run \
--header "Authorization: Bearer <token>"{
"id": "<string>",
"dateRangeFrom": "2023-11-07T05:31:56Z",
"invoice": "https://example.com/",
"subscriptions": [
{
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"externalId": "<string>",
"number": "S-00000001",
"name": "Fitness M",
"billingGroup": {},
"periods": [
{
"id": "<string>",
"contractPeriodCount": 123,
"contractPeriod": {},
"cancellationPeriod": {}
}
],
"status": "active",
"activatedAt": "2021-01-01T00:00:00+00:00",
"poNumber": "PO-00000001",
"contractDetails": {
"contractStart": "2023-11-07T05:31:56Z",
"contractEnd": "2023-11-07T05:31:56Z"
},
"trialEndsOn": "2021-01-01T00:00:00+00:00",
"customFields": {
"field1": "value1",
"field2": "value2"
},
"nextBillingDate": "2023-11-07T05:31:56Z",
"lastBillingAt": "2023-11-07T05:31:56Z",
"partner": {
"id": "ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b",
"name": "John Doe",
"number": "123456",
"email": "[email protected]"
}
}
],
"subscriptionItems": [
{
"id": "01F9ZQZJZJQZJZJZJZJZJZJZJZ",
"name": "Fitness M",
"description": "Everything included",
"furtherInformation": "Additional agreements: The contract includes a free drink flatrate.",
"status": "active",
"subscriptionId": "<string>"
}
],
"billedAt": "2023-11-07T05:31:56Z",
"dateRangeTo": "2023-11-07T05:31:56Z",
"usageBreakdownUrl": "<string>"
}Get billing run details for an invoice
Get all billing run details which created the invoice. This includes all subscriptions, subscription items and the date range which was billed.
Required permissions:invoice:readcurl -X GET \
/invoices/{invoiceId}/billing-run \
--header "Authorization: Bearer <token>"{
"id": "<string>",
"dateRangeFrom": "2023-11-07T05:31:56Z",
"invoice": "https://example.com/",
"subscriptions": [
{
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"externalId": "<string>",
"number": "S-00000001",
"name": "Fitness M",
"billingGroup": {},
"periods": [
{
"id": "<string>",
"contractPeriodCount": 123,
"contractPeriod": {},
"cancellationPeriod": {}
}
],
"status": "active",
"activatedAt": "2021-01-01T00:00:00+00:00",
"poNumber": "PO-00000001",
"contractDetails": {
"contractStart": "2023-11-07T05:31:56Z",
"contractEnd": "2023-11-07T05:31:56Z"
},
"trialEndsOn": "2021-01-01T00:00:00+00:00",
"customFields": {
"field1": "value1",
"field2": "value2"
},
"nextBillingDate": "2023-11-07T05:31:56Z",
"lastBillingAt": "2023-11-07T05:31:56Z",
"partner": {
"id": "ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b",
"name": "John Doe",
"number": "123456",
"email": "[email protected]"
}
}
],
"subscriptionItems": [
{
"id": "01F9ZQZJZJQZJZJZJZJZJZJZJZ",
"name": "Fitness M",
"description": "Everything included",
"furtherInformation": "Additional agreements: The contract includes a free drink flatrate.",
"status": "active",
"subscriptionId": "<string>"
}
],
"billedAt": "2023-11-07T05:31:56Z",
"dateRangeTo": "2023-11-07T05:31:56Z",
"usageBreakdownUrl": "<string>"
}Authorizations
Value for the Authorization header parameter.
Path Parameters
BillingRun identifier
Response
BillingRun resource
"https://example.com/"
Show child attributes
Show child attributes
"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"
The number of the subscription.
"S-00000001"
The name of the subscription. Defaults to the name of the plan. This will be used in the invoice for the grouping headers.
"Fitness M"
The billing group defines the billing cycle 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.
"active"
The date the subscription was activated.
"2021-01-01T00:00:00+00:00"
The po number of the subscription.
"PO-00000001"
The date the trial period ends.
"2021-01-01T00:00:00+00:00"
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
Show child attributes
Show child attributes
{ "field1": "value1", "field2": "value2" }The next billing date of the subscription.
The last billing date of the subscription.
The partner of the customer.
Show child attributes
Show child attributes
The ID of the partner
"ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b"
The name of the partner
"John Doe"
The customer number of the partner
"123456"
The email address of the partner
Show child attributes
Show child attributes
"01F9ZQZJZJQZJZJZJZJZJZJZJZ"
The name of the item which will be used in the invoice. The name is translated based on the customer's locale.
"Fitness M"
The description of the item which will be used in the invoice. The description is translated based on the customer's locale.
"Everything included"
Further information defines additional information for the item which will be displayed in the invoice.
"Additional agreements: The contract includes a free drink flatrate."
The status of the item.
Possible values:
active: The item is active and will be billed.canceled: The item is canceled and will be billed until the end of the contract.pending: The item is pending and will be billed after the contract start.terminated: The item is terminated and will not be billed.
active, canceled, pending, terminated "active"
The date range to which the billing run was created.
Public url to view the detailed usage breakdown of this billing run.
Was this page helpful?