Skip to main content
GET
/
v1
/
discounts
List Discounts
curl --request GET \
  --url https://{defaultHost}/v1/discounts \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/discounts"
  },
  "data": [
    {
      "id": "8b4302c9-5679-428c-91dc-9910e00a1d9c",
      "object": "discount",
      "discount_amount": -500,
      "primary": true,
      "redeemable_status": "redeemable",
      "redeemed_at": 1767909634,
      "used_up": false,
      "checkout": "94d62ce4-053c-4149-8dee-2ab1c6676814",
      "coupon": "15177ae2-29cb-4318-b322-6c099f5f4b4d",
      "customer": "997491bf-54f6-4251-b992-461c26ed321a",
      "primary_discount": null,
      "promotion": null,
      "created_at": 1767909694,
      "updated_at": 1767909694
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
coupon_ids[]
string[]

Only return objects with the given coupon IDs.

​
customer_ids[]
string[]

Only return objects that belong to the given customers.

​
limit
integer

A limit on the number of items to be returned, between 1 and 100.

​
page
integer

The page of items you want returned.

​
primary
boolean

Only return the primary discounts, the first one when the coupon is recurring.

​
primary_discount_ids[]
string[]

Only return objects that belong to the given primary discount.

​
promotion_ids[]
string[]

Only return objects with the given promotion IDs.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.