Skip to main content
PUT
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")

Query Parameters

expand
string

Comma-separated relations to expand: discount

Body

application/json
discount
string
required

ID of the discount to apply

Example:

"disc_O7Y256nbwxmDh6gMKZvD8pRB"

Response

Discount applied

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