Skip to main content
POST
Create payment coupon
Use the API Playground below to send this request with your X-Api-Key. Supply a unique code, type (amount or percent), and value; optionally scope to a payment link.

Authorizations

X-Api-Key
string
header
required

Body

application/json
code
string
required
type
enum<string>
required
Available options:
amount,
percent
value
number<float>
required
max_redemptions
integer | null
is_active
boolean
expires_at
string<date-time> | null

Response

201 - application/json

Created

id
string
code
string
type
enum<string>
Available options:
amount,
percent
value
number<float>
is_active
boolean
max_redemptions
integer | null
times_redeemed
integer
expires_at
string<date-time> | null
created_at
string<date-time>