Skip to main content
PUT
Update a discount coupon.

Authorizations

Authorization
string
header
required

Enter your access token (OAuth / JWT).

Path Parameters

discountCouponUid
string | null
required

The discount coupon's unique identifier

Body

application/json

The discount coupon's updated values

Uid
string | null
Maximum string length: 10
_objectType
string | null
ActivityEventData
unknown
UniqueIdentifier
string | null
Name
string | null
IsActive
boolean
AmountOff
number<decimal> | null
PercentOff
number<decimal> | null
RedeemBy
string<date-time> | null
Duration
enum<integer>

1 - Forever, 2 - Once, 3 - Repeating

Available options:
1,
2,
3
Required range: 1 <= x <= 3
DurationInMonths
integer<int32> | null
TimesRedeemed
integer<int32>
MaxRedemptions
integer<int32> | null
DiscountCouponPlans
object[] | null
ApplyToAddOns
boolean
PlanUids
string | null

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
UniqueIdentifier
string | null
Name
string | null
IsActive
boolean
AmountOff
number<decimal> | null
PercentOff
number<decimal> | null
RedeemBy
string<date-time> | null
Duration
enum<integer>

1 - Forever, 2 - Once, 3 - Repeating

Available options:
1,
2,
3
Required range: 1 <= x <= 3
DurationInMonths
integer<int32> | null
TimesRedeemed
integer<int32>
MaxRedemptions
integer<int32> | null
DiscountCouponPlans
object[] | null
ApplyToAddOns
boolean
PlanUids
string | null