Create a new coupon

POST

/v1/coupons

• Production API

Create a new coupon for the authenticated company

Authorizations

• bearerAuth

Request Body ^required

object

description

string

code

string

type

string

Allowed values: access coded public hold

amountOff

number

percentOff

number

limit

number

offeringIds

Array<string>

contextIds

Array<string>

Example

{
  "code": "SUMMER2024",
  "discountType": "percentage",
  "discountValue": 20,
  "maxUses": 100,
  "expiresAt": "2024-08-31T23:59:59Z"
}

Responses

200

Successfully created coupon

object

status

string

Example

ok

data

object

id

string

companyId

string

description

string

code

string

type

string

Allowed values: access coded public hold

amountOff

number

percentOff

number

limit

number

quantitySold

number

offeringIds

Array<string>

contextIds

Array<string>

status

string

Allowed values: active expired disabled sold_out

400

Bad request - invalid coupon data

object

status

string

Example

error

message

string

Example

An error occurred

error

string

401

Unauthorized - authentication required

object

status

string

Example

error

message

string

Example

An error occurred

error

string

500

Internal server error

object

status

string

Example

error

message

string

Example

An error occurred

error

string