Skip to main content
POST
Create coupon

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Coupon request

cadence
enum<string>
required
Available options:
once,
repeated,
forever
name
string
required
type
enum<string>
required
Available options:
fixed,
percentage
amount_off
string
coupon_code
string
currency
string
duration_in_periods
integer
max_redemptions
integer
metadata
object
percentage_off
string
redeem_after
string
redeem_before
string
rules
object

Response

Created

amount_off
string
cadence
enum<string>
Available options:
once,
repeated,
forever
coupon_code
string
created_at
string<date-time>
created_by
string
currency
string
duration_in_periods
integer
environment_id
string
id
string
max_redemptions
integer
metadata
object
name
string
percentage_off
string
redeem_after
string
redeem_before
string
rules
object
status
enum<string>
Available options:
published,
deleted,
archived
tenant_id
string
total_redemptions
integer
type
enum<string>
Available options:
fixed,
percentage
updated_at
string<date-time>
updated_by
string