Coupons

Returns a paginated list of coupons defined in your catalog

Returns a paginated list of coupons defined in your catalog.

GEThttps://example.thoughtindustries.com/incoming/v2/coupons

Example request

curl "https://example.thoughtindustries.com/incoming/v2/coupons" \
  -H 'Authorization: Bearer YOUR_API_KEY'

Parameters

Name	Type	Required	Location	Description
`page`	`integer`	No	query	Page number to retrieve in the paginated result set.

Example response

{
  "data": {
    "APICoupons": {
      "pageInfo": {
        "perPage": 0,
        "currentPage": 0,
        "total": 0,
        "hasMore": true
      },
      "coupons": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "active": true,
          "allowMultipleInCart": true,
          "appliesToUser": "existing",
          "code": "string",
          "timesRedeemed": 0,
          "maxRedemptions": 0,
          "redeemBy": "2024-01-01T00:00:00.000Z",
          "percentOff": 0,
          "amountOffInCents": 0,
          "multicurrencyAmountOff": {}
        }
      ]
    }
  }
}

Response fields

Field	Type	Description
`pageInfo`	`PageInfo`	Pagination metadata for the result set.
`pageInfo.perPage`	`integer`	Number of coupons returned per page.
`pageInfo.currentPage`	`integer`	The current page number in the result set.
`pageInfo.total`	`integer`	Total number of coupons across all pages.
`pageInfo.hasMore`	`boolean`	Indicates whether additional pages of results are available.
`coupons`	`Coupon[]`	Array of coupon objects returned for the current page.
`coupons.id`	`uuid`	Unique identifier for the coupon.
`coupons.active`	`boolean`	Indicates whether the coupon is currently active and available for use.
`coupons.allowMultipleInCart`	`boolean`	Indicates whether the coupon can be applied alongside other coupons in the same cart.
`coupons.appliesToUser`	`AppliesToUser`	Specifies which users the coupon applies to (e.g., `existing` users only or new users).
`coupons.code`	`string`	The redemption code learners enter to apply the coupon.
`coupons.timesRedeemed`	`integer`	Number of times the coupon has been redeemed to date.
`coupons.maxRedemptions`	`integer`	Maximum number of times the coupon can be redeemed in total.
`coupons.redeemBy`	`ISO 8601 timestamp`	Expiration date and time after which the coupon can no longer be redeemed, in ISO 8601 format.
`coupons.percentOff`	`number`	Percentage discount applied to the purchase price when the coupon is redeemed.
`coupons.amountOffInCents`	`integer`	Fixed discount amount in cents applied to the purchase price when the coupon is redeemed.
`coupons.multicurrencyAmountOff`	`object`	Fixed discount amounts keyed by currency code, used when multi-currency pricing is enabled.