Coupons
Get coupon
Retrieve the details of an existing coupon.
GET
/
v1
/
coupons
/
{id}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
id
string
requiredResponse
200 - application/json
id
string
requiredCoupon ID.
name
string
requiredCoupon name.
description
string | null
requiredCoupon description.
expiration_date
string | null
requiredDate corresponding to the expiration of the coupon.
redemption_limit
number | null
requiredNumber of times the coupon can be used when applied on a subscription.
created_at
string
requiredUTC date time string in the ISO 8601 format.
type
enum<string>
requiredAvailable options:
amount
discount_amount
number
requiredAmount to apply as a discount on the total amount (excluding taxes) of a subscription. Expressed in the currency's smallest unit.
currency
string
requiredCurrency code. See ISO 4217.