Skip to main content
POST
Create Invoice Preview

Authorizations

Authorization
string
header
required

Service (M2M) access token issued by POST /auth/token using the client_credentials grant. Required scopes, where known, are listed on each operation below.

Body

application/json
provider_subscription_id
string
required

Provider subscription id to preview the upcoming invoice for (e.g. test_subscription_id).

discounts
object[]

Ad-hoc, not-yet-applied discounts to simulate. Each entry has exactly one of coupon or promotion_code. Omitted entirely when not provided, in which case the preview inherits the subscription/customer's existing discounts.

Response

Success.

data
object
required