CouponCodes

List codes for a coupon

Returns a paginated list of CouponCodes belonging to the given Coupon. Use this to inspect which codes have been generated, their validity windows, and whether they've been pre-allocated to specific customers.

Requires the RESERVATIONS_VIEW permission on the coupon's site.

get/shop/coupons/{couponId}/codes

Query parameters

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

A paginated list of CouponCodes for the parent coupon.

Example response

{
  "data": [
    {
      "id": "5f1234567890abcdef123456",
      "code": "SUMMER2026",
      "coupon_id": "5f1234567890abcdef123456",
      "valid_from_date": "2026-06-01T00:00:00Z",
      "valid_to_date": "2026-08-31T23:59:59Z",
      "customer_credit_id": "5f1234567890abcdef123456",
      "customer_id": "11111111-1111-1111-1111-111111111111",
      "revenue": 5000
    }
  ]
}

Changes

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