Sign in

v52

latestOpenAPI 3.0.1AGPL-3.0raw.githubusercontent.com2026-08-01255473862.7 KB
Coupons

Create coupon

Use when creating a discount (e.g. promo code or referral). Ideal for percent or fixed value, with optional validity and usage limits.

post/coupons

Request body

amount_offstring
cadence'once' | 'repeated' | 'forever' required
coupon_codestring
currencystring
duration_in_periodsinteger
max_redemptionsinteger
metadataobject
namestring required
percentage_offstring
redeem_afterstring
redeem_beforestring
rulesobject
type'fixed' | 'percentage' required

Response

Created

amount_offstring
cadence'once' | 'repeated' | 'forever'
coupon_codestring
created_atstring date-time
created_bystring
currencystring
duration_in_periodsinteger
environment_idstring
idstring
max_redemptionsinteger
metadataobject
namestring
percentage_offstring
redeem_afterstring
redeem_beforestring
rulesobject
status'published' | 'deleted' | 'archived'
tenant_idstring
total_redemptionsinteger
type'fixed' | 'percentage'
updated_atstring date-time
updated_bystring