Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Path Parameters

id
string
required

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

Response

Subscription canceled

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
canceled
boolean
required
paused
boolean
required