Update Coupon
Replace a coupon’s settings
Headers
"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"
Path Parameters
The coupon ID.
Body
Full coupon settings (every required field).
Coupon name, shown in the dashboard.
64"Year End Sale"
Code customers enter at checkout. Must be unique among the business's active coupons.
64"YEAREND10"
Fixed discount amount. Sent in major currency units (for example 5 = SGD 5.00). Responses return it in minor units (cents), for example 500. Send 0 for a percentage-only coupon. fixed_amount and percentage cannot both be 0.
0 <= x <= 999999.995
Percentage discount as a fraction, up to 4 decimal places (0.15 = 15%). Send 0 for a fixed-amount-only coupon.
0 <= x <= 10
Show this coupon in the store's promo banner. Setting it to true turns the banner off for every other coupon and discount of the business.
false
What the coupon applies to: 1 = all products, 2 = specific categories, 3 = specific products.
1, 2, 3 2
Minimum cart amount for the coupon to apply. Sent in major currency units (for example 5 = SGD 5.00). Responses return it in minor units (cents), for example 500.
x >= 020
Text for the promo banner.
1000null
How many times the coupon can still be used. Omit or send null for unlimited.
100
Category IDs (coupon_type 2) or product IDs (coupon_type 3). Required for types 2 and 3, ignored for type 1.
36When the coupon becomes valid, read in the business's timezone. Omit for no start date.
"2026-11-01"
When the coupon expires, read in the business's timezone. Must be on or after starts_at. Omit for no end date.
"2026-12-31"
Response
200
Fixed discount in minor units (cents).
Percentage discount as a fraction (0.15 = 15%).
Remaining uses; null = unlimited.
UTC.
UTC.
1, 2, 3 Minimum cart amount in minor units (cents).
Categories or products the coupon applies to. Empty for coupon_type 1.