Skip to main content
GET
/
api
/
v1
/
coupons
List coupons
curl --request GET \
  --url https://api.example.com/api/v1/coupons \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "code": "<string>",
      "description": "<string>",
      "disabled": true,
      "discount": {
        "percentage": "<string>"
      },
      "id": "<string>",
      "reusable": true,
      "expires_at": "2023-11-07T05:31:56Z",
      "recurring_value": 123,
      "redemption_limit": 123
    }
  ],
  "pagination_meta": {
    "page": 1,
    "per_page": 1,
    "total_items": 1,
    "total_pages": 1
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

filter
enum<string>
Available options:
ALL,
ACTIVE,
INACTIVE,
ARCHIVED
page
integer<int32>

Page number (0-indexed)

Required range: x >= 0
per_page
integer<int32>

Number of items per page

Required range: 1 <= x <= 100

Response

List of coupons

data
object[]
required
pagination_meta
object
required