Create coupon

POST

/v1/coupons/

Create a new coupon.

Request Body ^required

CouponCreate

object

code

required

Code

string

<= 255 characters

name

required

Name

string

<= 255 characters

description

Any of:

string

string

null

null

coupon_type

required

CouponType

string

Allowed values: fixed_amount percentage

amount_cents

Any of:

number

number

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

null

null

amount_currency

Any of:

string

string

>= 3 characters <= 3 characters

null

null

percentage_rate

Any of:

number

number

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

null

null

frequency

required

CouponFrequency

string

Allowed values: once recurring forever

frequency_duration

Any of:

integer

integer

null

null

reusable

Reusable

boolean

default: true

expiration

CouponExpiration

string

default: no_expiration

Allowed values: no_expiration time_limit

expiration_at

Any of:

string

string format: date-time

null

null

Responses

201

Successful Response

CouponResponse

object

id

required

Id

string format: uuid

code

required

Code

string

name

required

Name

string

description

Any of:

string

string

null

null

coupon_type

required

Coupon Type

string

amount_cents

Any of:

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

null

null

amount_currency

Any of:

string

string

null

null

percentage_rate

Any of:

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

null

null

frequency

required

Frequency

string

frequency_duration

Any of:

integer

integer

null

null

reusable

required

Reusable

boolean

expiration

required

Expiration

string

expiration_at

Any of:

string

string format: date-time

null

null

status

required

Status

string

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

401

Unauthorized

409

Coupon with this code already exists

422

Validation error