Sign in

v52

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

Get coupon by code

Use when resolving a coupon by promo code (e.g. checkout or validation).

get/coupons/code/{code}

Path parameters

codestring required

Coupon code

Response

OK

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