Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key
string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Path Parameters

id
string
required

The resource ID (e.g., "prod_abc123") or slug (e.g., "my-product")

Response

Subscription resumed

id
string
required
object
string
required
status
string | null
required
quantity
integer
required
current_period_start
string<date-time> | null
required
current_period_end
string<date-time> | null
required
trial_ends_at
string<date-time> | null
required
ends_at
string<date-time> | null
required
created_at
string<date-time> | null
required
updated_at
string<date-time> | null
required
livemode
boolean
required
canceled
boolean
required
paused
boolean
required
cancellation_details
object | null
required

What the customer told you when they last cancelled from the billing portal. Null if they never did.

customer

ID by default, full object when expanded

order

ID by default, full object when expanded

discount

ID by default, full object when expanded