Sign in
Coupons

List coupons

This endpoint lists coupons for an organisation. By default, only manual redemption coupons are returned. Use the redemption_type filter to retrieve programmatic coupons (credit types).

get/shop/coupons

Query parameters

per_pageinteger

The number of results to return per page

pageinteger

The page to retrieve results from

site_idstring

Filter results by the site they belong to

redemption_type'manual' | 'programmatic'

Filter coupons by redemption type. When not provided, defaults to manual.

Response

A list of coupons

Example response

{
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  },
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "data": [
    {
      "name": "Test coupon",
      "description": "This coupon is a test",
      "offering_discounts": [
        {
          "offerings": [
            {
              "offering_name": "Test offering"
            }
          ],
          "fixed_amount": 50,
          "percentage": 10
        }
      ],
      "currency": "gbp",
      "valid_weekdays": [
        "monday"
      ],
      "default_validity_interval": "P1Y",
      "default_multi_use": true,
      "for_lead_booker_only": true,
      "max_uses": 2,
      "redemption_type": "manual",
      "created_at": "2020-02-24T12:00:00+01:00",
      "updated_at": "2020-02-24T12:00:00+01:00",
      "deleted_at": "2020-02-24T12:00:00+01:00"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.