Sign in
Billing

Preview a Paddle Billing subscription transaction

Changed on

Preview the cost and details of a Billing subscription before creation

post/billing/subscriptions/{subscription_id}/preview

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in header x-pollination-token

Path parameters

subscription_idstring required

Request body

Response

Successful Response

idstring required
status'active' | 'canceled' | 'past_due' | 'paused' | 'trialing' required

An enumeration.

customer_idstring required
currency_codestring required
created_atstring date-time required
updated_atstring date-time required
started_atstring date-time
first_billed_atstring date-time
next_billed_atstring date-time
paused_atstring date-time
canceled_atstring date-time
collection_modestring
billing_detailsobject
scheduled_changeobject
custom_dataobject
discountobject

Changes