v11

latestOpenAPI 3.1.12026-08-03174162.0 MB
Coupons

Get coupon by ID

get/coupons/{id}

Path parameters

idstring required

A unique identifier for this coupon.

Example:cpn_01jps5cgsfzs1ksqaet5hba8ac

Response

OK

Example response

{
  "coupon": {
    "id": "cpn_01jps5cgsfzs1ksqaet5hba8ac",
    "couponId": "cpn_01jps5cgsfzs1ksqaet5hba8ac",
    "createdAt": "2026-08-03T06:13:52.214Z",
    "updatedAt": "2026-08-03T06:13:52.214Z",
    "name": "Half Price",
    "active": true,
    "kind": "PERCENT",
    "filter": "EVENTS",
    "currency": "AUD",
    "discount": 50,
    "limit": -1,
    "saleStartsAt": "2025-02-10T03:00:00"
  }
}