Skip to main content
GET
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

Discount details

id
string
required
object
string
required
status
enum<string>
required
Available options:
active,
inactive
discount_type
enum<string>
required
Available options:
percentage,
fixed
code
string
required
amount_off
integer | null
required
duration
enum<string>
required
Available options:
forever,
once,
repeating
duration_in_months
integer | null
required
max_redemptions
integer | null
required
times_redeemed
integer
required
redeem_by
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
percent_off
number<double> | null
required
currency
string | null
required