Retrieves the entitlement's billing record.
const url = 'https://example.com/api/v1/provision/admin/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/billing';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/v1/provision/admin/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/billingParameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Entitlement id.
Responses
Section titled “Responses”OK
The billing record of an entitlement, or the billing template of an offer: who bills it and how, the invoice recipient, the customer’s own reference, an amount recorded for the vendor’s overview, and the provider’s identifiers. Provision writes the provider anchors and the subscription state from the connector’s events; everything else is the operator’s.
object
One of BillingProviders, or a value a connector registered.
Who drives the entitlement’s plan. A member this client does not know reads as BillingModeDto.Unknown.
Why an operator manages the plan by hand; set with BillingModeDto.OperatorManaged.
How money is collected for the entitlement. A member this client does not know reads as BillingMethodDto.Unknown.
How often the entitlement bills. A member this client does not know reads as BillingIntervalDto.Unknown.
Informational: what the vendor recorded for their own overview. Never used to charge, never checked against plan prices.
ISO 4217 code of decimal? EntitlementBillingDto.Amount.
The provider’s own customer id (cus_…); written by Provision from the subscription event.
The provider’s own subscription id (sub_…); unique per tenant and provider, written by Provision.
The customer’s purchase order number or cost centre — what must appear on the invoice.
ISO 3166-1 alpha-2.
Provider-specific key-values, keys prefixed by provider (stripe.price_lookup_key).
object
Where the provider’s subscription stands, as Provision last recorded it from the subscription event. The connector holds the live picture; this is the copy the entitlement list filters on.
Start of the open past-due episode, when a payment failed and none has succeeded since.
When a lapse was recorded that could not be applied yet because another plan override stands.
When the payment lapse was applied to the plan; null once a payment or an operator lifts it.
The billing record of an entitlement, or the billing template of an offer: who bills it and how, the invoice recipient, the customer’s own reference, an amount recorded for the vendor’s overview, and the provider’s identifiers. Provision writes the provider anchors and the subscription state from the connector’s events; everything else is the operator’s.
object
One of BillingProviders, or a value a connector registered.
Who drives the entitlement’s plan. A member this client does not know reads as BillingModeDto.Unknown.
Why an operator manages the plan by hand; set with BillingModeDto.OperatorManaged.
How money is collected for the entitlement. A member this client does not know reads as BillingMethodDto.Unknown.
How often the entitlement bills. A member this client does not know reads as BillingIntervalDto.Unknown.
Informational: what the vendor recorded for their own overview. Never used to charge, never checked against plan prices.
ISO 4217 code of decimal? EntitlementBillingDto.Amount.
The provider’s own customer id (cus_…); written by Provision from the subscription event.
The provider’s own subscription id (sub_…); unique per tenant and provider, written by Provision.
The customer’s purchase order number or cost centre — what must appear on the invoice.
ISO 3166-1 alpha-2.
Provider-specific key-values, keys prefixed by provider (stripe.price_lookup_key).
object
Where the provider’s subscription stands, as Provision last recorded it from the subscription event. The connector holds the live picture; this is the copy the entitlement list filters on.
Start of the open past-due episode, when a payment failed and none has succeeded since.
When a lapse was recorded that could not be applied yet because another plan override stands.
When the payment lapse was applied to the plan; null once a payment or an operator lifts it.
Example
{ "mode": "ProviderManaged", "method": "Unspecified", "interval": "Unspecified", "state": "Unknown"}The billing record of an entitlement, or the billing template of an offer: who bills it and how, the invoice recipient, the customer’s own reference, an amount recorded for the vendor’s overview, and the provider’s identifiers. Provision writes the provider anchors and the subscription state from the connector’s events; everything else is the operator’s.
object
One of BillingProviders, or a value a connector registered.
Who drives the entitlement’s plan. A member this client does not know reads as BillingModeDto.Unknown.
Why an operator manages the plan by hand; set with BillingModeDto.OperatorManaged.
How money is collected for the entitlement. A member this client does not know reads as BillingMethodDto.Unknown.
How often the entitlement bills. A member this client does not know reads as BillingIntervalDto.Unknown.
Informational: what the vendor recorded for their own overview. Never used to charge, never checked against plan prices.
ISO 4217 code of decimal? EntitlementBillingDto.Amount.
The provider’s own customer id (cus_…); written by Provision from the subscription event.
The provider’s own subscription id (sub_…); unique per tenant and provider, written by Provision.
The customer’s purchase order number or cost centre — what must appear on the invoice.
ISO 3166-1 alpha-2.
Provider-specific key-values, keys prefixed by provider (stripe.price_lookup_key).
object
Where the provider’s subscription stands, as Provision last recorded it from the subscription event. The connector holds the live picture; this is the copy the entitlement list filters on.
Start of the open past-due episode, when a payment failed and none has succeeded since.
When a lapse was recorded that could not be applied yet because another plan override stands.
When the payment lapse was applied to the plan; null once a payment or an operator lifts it.
Example
{ "mode": "ProviderManaged", "method": "Unspecified", "interval": "Unspecified", "state": "Unknown"}Not Found
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}