Skip to main content
POST
Create Coupon

Authorizations

Authorization
string
header
required

API key (sk_test_* or sk_live_*)

Body

application/json
duration
enum<string>
required
Available options:
once,
repeating,
forever
id
string

Custom coupon code

name
string
percent_off
number
Required range: 0 <= x <= 100
amount_off
integer
currency
string
duration_in_months
integer
max_redemptions
integer
redeem_by
integer
applies_to
object
metadata
object

Response

Coupon created

id
string
object
enum<string>
Available options:
coupon
name
string
percent_off
number
amount_off
integer
currency
string
duration
string
duration_in_months
integer
max_redemptions
integer
times_redeemed
integer
redeem_by
integer
applies_to
object
valid
boolean
metadata
object
created
integer