PATCH
/
discounts
/
{discount_id}

Authorizations

Authorization
string
header
required

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

Path Parameters

discount_id
string
required

Discount Id

Body

application/json

Request body for patching (updating) a discount.

All fields are optional and only update if provided.

amount
integer | null

If present, update the discount amount:

  • If discount_type is percentage, this represents basis points (e.g., 540 = 5.4%).
  • Otherwise, this represents USD cents (e.g., 100 = $1.00).

Must be at least 1 if provided.

code
string | null

If present, update the discount code (uppercase).

expires_at
string | null
name
string | null
restricted_to
string[] | null

If present, replaces all restricted product IDs with this new set. To remove all restrictions, send empty array

type
enum<string>
Available options:
percentage
usage_limit
integer | null

Response

200
application/json
Updated discount
amount
integer
required

The discount amount.

  • If discount_type is percentage, this is in basis points (e.g., 540 => 5.4%).
  • Otherwise, this is USD cents (e.g., 100 => $1.00).
business_id
string
required

The business this discount belongs to.

code
string
required

The discount code (up to 16 chars).

created_at
string
required

Timestamp when the discount is created

discount_id
string
required

The unique discount ID

restricted_to
string[]
required

List of product IDs to which this discount is restricted.

times_used
integer
required

How many times this discount has been used.

type
enum<string>
required
Available options:
percentage
expires_at
string | null

Optional date/time after which discount is expired.

name
string | null

Name for the Discount

usage_limit
integer | null

Usage limit for this discount, if any.