Skip to main content
POST
Create a discount

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
amount
string
required

Discount value as a decimal string. For amount_off, this is in major/minor currency units (for example, "1.25"). For percentage_off, this is a whole-number percentage ("1.00" means 1%).

Pattern: ^[0-9]+(\.[0-9]+)?$
Example:

"199.99"

type
enum<string>
required

How amount is applied: as a fixed monetary reduction or a percentage reduction.

Available options:
amount_off,
percentage_off
name
string | null

Human-readable discount name, or null when the discount is unnamed.

Response

A fixed or percentage reduction a cashier can apply to an order at the register.

id
string
required

Unique identifier for the record.

amount
string
required

Discount value as a decimal string. For amount_off, this is in major/minor currency units (for example, "1.25"). For percentage_off, this is a whole-number percentage ("1.00" means 1%).

Pattern: ^[0-9]+(\.[0-9]+)?$
Example:

"199.99"

created_at
string<date-time>
required

When the record was created.

name
string | null
required

Human-readable discount name, or null when the discount is unnamed.

type
enum<string>
required

How amount is applied: as a fixed monetary reduction or a percentage reduction.

Available options:
amount_off,
percentage_off
updated_at
string<date-time>
required

When the record was last changed.