Skip to main content
GET
/
v1
/
coupons
List
curl --request GET \
  --url https://{defaultHost}/v1/coupons \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 3,
    "limit": 20,
    "page": 1,
    "url": "/v1/coupons"
  },
  "data": [
    {
      "id": "e1f6567c-d002-4b01-a011-efb2f6f03bac",
      "object": "coupon",
      "archived": false,
      "archived_at": null,
      "amount_off": 500,
      "currency": "usd",
      "duration": "once",
      "duration_in_months": null,
      "expired": false,
      "metadata": {},
      "max_redemptions": null,
      "max_redemptions_per_customer": null,
      "max_subtotal_amount": null,
      "min_subtotal_amount": null,
      "name": "Test Coupon",
      "percent_off": null,
      "product_ids": [],
      "redeem_by": null,
      "times_redeemed": 0,
      "discarded_at": null,
      "created_at": 1772112929,
      "updated_at": 1772112929
    },
    {
      "id": "23563fe8-7b9e-4c2a-9234-bf4afa80a3d1",
      "object": "coupon",
      "archived": false,
      "archived_at": null,
      "amount_off": 500,
      "currency": "usd",
      "duration": "once",
      "duration_in_months": null,
      "expired": false,
      "metadata": {},
      "max_redemptions": null,
      "max_redemptions_per_customer": null,
      "max_subtotal_amount": null,
      "min_subtotal_amount": null,
      "name": "Test Coupon",
      "percent_off": null,
      "product_ids": [],
      "redeem_by": null,
      "times_redeemed": 0,
      "discarded_at": null,
      "created_at": 1772112929,
      "updated_at": 1772112929
    },
    {
      "id": "8d27f673-33f1-4442-b9e3-5178700c0a27",
      "object": "coupon",
      "archived": false,
      "archived_at": null,
      "amount_off": 500,
      "currency": "usd",
      "duration": "once",
      "duration_in_months": null,
      "expired": false,
      "metadata": {},
      "max_redemptions": null,
      "max_redemptions_per_customer": null,
      "max_subtotal_amount": null,
      "min_subtotal_amount": null,
      "name": "Test Coupon",
      "percent_off": null,
      "product_ids": [],
      "redeem_by": null,
      "times_redeemed": 0,
      "discarded_at": null,
      "created_at": 1772112929,
      "updated_at": 1772112929
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
archived
boolean

Only return objects that are archived or not archived.

​
ids[]
string[]

Only return objects with the given IDs.

​
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.

​
query
string

The query to be used for full text search of this collection.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.