Skip to main content
GET
Get Subscription History

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Scopes

Headers

Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

company_id
string
required

The company ID with the prefix 'cmp_'.

id
string
required

The resource ID

Response

200 - application/json

OK

actual_change_time
null | string<date-time>

The actual change time of the subscription change

all_product_pricings
object[]

All product pricings including those in ProductPricingIDs and OneTimeItems

auto_charges
null | boolean

Whether the subscription invoices are automatically charged

bundle_pricing
object

The bundle pricing representing the plan selection for this change

bundle_pricing_id
null | string

The bundle pricing id representing the plan selection for this change

config_items
object[] | null

Configuration items stored on the subscription at this stage

custom_change_date
null | string<date-time>

The custom date of the subscription change if the change was a custom date change.

discounts
null | object[]

Discount parameters stored on the subscription at this stage

effective_change_date
null | string<date-time>

The date the subscription change was meant to take effect, regardless of the actual change time

metadata
object

Metadata stored on the subscription at this stage

minimum_spend
object

The minimum spend of the subscription change

onetime_items
object[] | null

One time items to be charged at this stage

payment_method_id
null | string

The payment method that should specifically be used to charge the invoices for this subscription

product_pricing_ids
string[] | null

The product pricing ids representing the plan selection for this change

proration_type
string | null

How to prorate charges for the subscription change

relative_term
object

The relative term of the subscription change. Used if the timing is RELATIVE

reset_billing_anchor
null | boolean

Whether to reset the billing anchor for the subscription change

term
object

The term of the subscription change

timing
string | null

The timing of the subscription change

trial
null | boolean

Whether the subscription change is trial

trial_term
object

The trial term of the subscription change