Skip to main content
GET
/
v1
/
discounts
List Discounts
curl --request GET \
  --url https://api.spairehq.com/v1/discounts/ \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "amount": 123,
      "currency": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "metadata": {},
      "name": "<string>",
      "code": "<string>",
      "starts_at": "2023-11-07T05:31:56Z",
      "ends_at": "2023-11-07T05:31:56Z",
      "max_redemptions": 123,
      "redemptions_count": 123,
      "organization_id": "<string>",
      "products": [
        {
          "metadata": {},
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "trial_interval_count": 123,
          "name": "<string>",
          "description": "<string>",
          "recurring_interval_count": 123,
          "is_recurring": true,
          "is_archived": true,
          "organization_id": "<string>",
          "product_type": "digital"
        }
      ]
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.spairehq.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

You can generate a Personal Access Token from your settings.

Query Parameters

​
organization_id

Filter by organization ID. The organization ID.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

​
query
string | null

Filter by name.

​
page
integer
default:1

Page number, defaults to 1.

​
limit
integer
default:10

Size of a page, defaults to 10. Maximum is 100.

​
sorting
enum<string>[] | null

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Available options:
created_at,
-created_at,
name,
-name,
code,
-code,
redemptions_count,
-redemptions_count

Response

Successful Response

​
items
(DiscountFixedOnceForeverDuration · object | DiscountFixedRepeatDuration · object | DiscountPercentageOnceForeverDuration · object | DiscountPercentageRepeatDuration · object)[]
required

Schema for a fixed amount discount that is applied once or forever.

​
pagination
Pagination · object
required