Sign in

v1

latestOpenAPI 3.0.32026-07-248079274.0 KB
Coupons

List all coupons

Returns a paginated list of coupons.

get/coupons

Query parameters

status'active' | 'expired' | 'archived'

Filter by coupon status.

offsetinteger

The record to start the response on.

limitinteger

A limit on the scope of values returned in the response.

Response

List of coupons.

Example response

{
  "meta": {
    "links": [
      {
        "rel": "first",
        "href": "/v1/path?offset=0",
        "title": "first page"
      }
    ]
  },
  "data": [
    {
      "id": "01JCX5Y8K9M3N4P6Q7R8S9T0UV",
      "name": "Summer Sale 20%",
      "discount_type": "percentage",
      "value": 20,
      "duration": "repeating",
      "duration_in_cycles": 3,
      "max_redemptions": 100,
      "times_redeemed": 5,
      "status": "active",
      "links": [
        {
          "rel": "self",
          "href": "/v1/coupons/01JCX5Y8K9M3N4P6Q7R8S9T0UV",
          "method": "GET"
        }
      ]
    }
  ]
}