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": "620f9760-cc92-4e17-97d4-4986c3270b67",
      "object": "discount",
      "discount_amount": -500,
      "primary": true,
      "redeemable_status": "redeemable",
      "redeemed_at": 1770234791,
      "used_up": false,
      "checkout": "5d024b65-21bf-4f27-8886-89953a7ca073",
      "coupon": "abe5f257-15d6-4fee-b1a9-d78da3571fae",
      "customer": "c18a4377-bcb6-4eec-81ce-204973ceaa90",
      "primary_discount": null,
      "promotion": null,
      "created_at": 1770234852,
      "updated_at": 1770234852
    }
  ]
}

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.