List coupons

Retrieve existing coupons.

GET /v1/coupons

List coupons

cURL

curl --request GET \
  --url https://api.hyperline.co/v1/coupons \
  --header 'Authorization: Bearer <token>'

200

{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0
  },
  "data": [
    {
      "id": "cou_DKL4Xcb5VSa8CQ",
      "name": "Partner discount",
      "description": null,
      "expiration_date": null,
      "redemption_limit": null,
      "product_ids": [
        "itm_DKL4Xcb5VSa8CQ",
        "itm_1234567890abcdef"
      ],
      "created_at": "2024-12-20T16:04:11Z",
      "discount_amount": 2000,
      "currency": "EUR"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

take · number | null · default: 50

Required range: 0 <= x <= 100

skip · number | null · default: 0

Required range: x >= 0

Response

200 - application/json

meta · object · required

Show child attributes

data · (Coupon amount · object | Coupon percent · object)[] · required

List of Coupon.

Coupon amount

Coupon percent

Show child attributes