v1

latestOpenAPI 3.1.02026-07-222392081.7 MB
Coupons

List coupons

Retrieve existing coupons.

get/v1/coupons

Query parameters

takenumber nullable
skipnumber nullable

Response

Example response

{
  "meta": {
    "total": 1,
    "taken": 1
  },
  "data": [
    {
      "id": "cou_DKL4Xcb5VSa8CQ",
      "name": "Partner discount",
      "product_ids": [
        "itm_DKL4Xcb5VSa8CQ",
        "itm_1234567890abcdef"
      ],
      "repeat": "duration",
      "duration": {
        "count": 3,
        "period": "months"
      },
      "created_at": "2024-12-20T16:04:11Z",
      "integrations": [
        {
          "entity_id": "123456789",
          "provider_name": "stripe",
          "provider_account_id": "acc_1234567890"
        }
      ],
      "discount_amount": 2000,
      "currency": "EUR"
    }
  ]
}