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

Create coupon

cURL

curl --request POST \
  --url https://us.api.flexprice.io/v1/coupons \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "amount_off": "<string>",
  "currency": "<string>",
  "duration_in_periods": 123,
  "max_redemptions": 123,
  "metadata": {},
  "percentage_off": "<string>",
  "redeem_after": "<string>",
  "redeem_before": "<string>",
  "rules": {}
}
'

201

{
  "amount_off": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "currency": "<string>",
  "duration_in_periods": 123,
  "environment_id": "<string>",
  "id": "<string>",
  "max_redemptions": 123,
  "metadata": {},
  "name": "<string>",
  "percentage_off": "<string>",
  "redeem_after": "<string>",
  "redeem_before": "<string>",
  "rules": {},
  "tenant_id": "<string>",
  "total_redemptions": 123,
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": "<string>"
}

Authorizations

ApiKeyAuthApiKeyAuth

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

currency · string

duration_in_periods · integer

max_redemptions · integer

metadata · object

Show child attributes

percentage_off · string

redeem_after · string

redeem_before · string

rules · object

Response

201

application/json

Created

amount_off · string

cadence · enum<string>

Available options: once, repeated, forever

created_at · string<date-time>

created_by · string

currency · string

duration_in_periods · integer

environment_id · string

id · string

max_redemptions · integer

metadata · object

Show child attributes

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