v1

latestOpenAPI 3.1.02026-07-222392081.7 MB

Coupons > Promotion codes

List promotion codes

Retrieve existing promotion codes.

get/v1/promotion-codes

Query parameters

takenumber nullable

skipnumber nullable

coupon_idstring

coupon_id__notstring

coupon_id__isNullstring

coupon_id__isNotNullstring

coupon_id__equalsstring

coupon_id__containsstring

coupon_id__startsWithstring

coupon_id__endWithstring

Response

Example response

{
  "meta": {
    "total": 1,
    "taken": 1
  },
  "data": [
    {
      "id": "promo_DKL4Xcb5VSa8CQ",
      "code": "PROMO123",
      "coupon_id": "cou_DKL4Xcb5VSa8CQ",
      "client_id": "cli_DKL4Xcb5VSa8CQ",
      "customer_id": "cus_DKL4Xcb5VSa8CQ",
      "plan_id": "plan_DKL4Xcb5VSa8CQ",
      "product_id": "itm_DKL4Xcb5VSa8CQ",
      "created_at": "2021-01-01T00:00:00.000Z",
      "updated_at": "2021-01-01T00:00:00.000Z",
      "expires_at": "2021-01-01T00:00:00.000Z",
      "max_redemptions": 10,
      "duration_count": 1,
      "duration_period": "months"
    }
  ]
}