Skip to main content
POST
Preview subscription transition

Authorizations

Authorization
string
header
required

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

Body

application/json
transition_id
string
required

The ID of an existing subscription transition to preview. Use this instead of providing a full payload to preview a transition that has already been scheduled.

Response

200 - application/json
transition_documents
object[]
required

All invoices and credit notes that would be emitted at transition time, including each credit note when a proration refund is split across source invoices. Empty when no transition documents are emitted, for example with do_not_charge. Use each document's type to distinguish invoices from credit notes.

next_invoice_after_transition
object
required

The invoice that would be emitted at the next renewal after the transition. Null if no renewal invoice would be emitted.