Skip to main content
GET
Retrieve a coupon.

Authorizations

Authorization
string
header
required

Enter your access token (OAuth / JWT).

Path Parameters

couponUid
string | null
required

The coupon's unique identifier

Response

Created
string<date-time>
required
read-only
Minimum string length: 1
Updated
string<date-time>
required
read-only
Minimum string length: 1
Uid
string | null
Maximum string length: 10
_objectType
string | null
ActivityEventData
unknown
SchemaLessData
object | null
StripeId
string | null
Maximum string length: 255
IsLivemode
boolean
AmountOff
integer<int64> | null
AppliesToProducts
object[] | null
Currency
string | null
Maximum string length: 3
Duration
string | null
Maximum string length: 30
DurationInMonths
integer<int64> | null
MaxRedemptions
integer<int64> | null
Name
string | null
Maximum string length: 250
PercentOff
number<decimal> | null
RedeemBy
string<date-time> | null
TimesRedeemed
integer<int64>
Valid
boolean
AppliesToProductIds
string[] | null
CanDelete
boolean
CurrencySymbol
string | null
CurrencyAmountOff
number<decimal> | null