BillKit/DocsConsole
Coupons

List coupons

List coupons, newest first.

GET/v1/coupons
Operation list_coupons·Scope coupons:read·OpenAPI v1.1.0

Parameters

ParameterDescription
limitinteger · queryoptionalMaximum number of objects to return. Defaults to 10. Between 1 and 100.
starting_afterstring | null · queryoptionalCursor for pagination: the id of the last object on the previous page. Returns the objects listed after it. An id that names no such object is a 400. At most 128 characters.

Cursor-paginated. limit caps a page and starting_after takes the last id you saw.

Returns

Returns a page of CouponResponse objects. data holds the page and has_more says whether another one exists. Page forward by passing the last id of the page as starting_after; a short page is not the end of the list.

Errors

StatusCause
400The request was refused (type: invalid_request_error): a required parameter is missing (parameter_missing), one failed validation (parameter_invalid) or is not one the operation takes (parameter_unknown), and param names it.
401No credential, or one that does not authenticate.
402The account is suspended (tenant_suspended), or the payment provider refused a charge or refund the call made (type: payment_error, code: payment_refused).
403Authenticated, but not allowed: missing scope (insufficient_scope), a key of the wrong mode (mode_mismatch), or a refused origin. Needs the coupons:read scope.
404No such object in this account and mode.
429Rate limited. Retry-After says when to try again.
500Something failed on BillKit's side (type: api_error). Retry with the same Idempotency-Key.
503Temporarily unable to serve. reason says whether the request was attempted.
Request · curl
curl -X GET https://api.billkit.eu/v1/coupons \
  -H "Authorization: Bearer $BILLKIT_API_KEY"
Response · 200 OK
{
  "data": [
    {
      "active": false,
      "amount_off_cents": 1900,
      "applies_to_price_ids": [
        "string"
      ],
      "code": "string",
      "created": 1789392000,
      "currency": "EUR",
      "discount_type": "percent",
      "duration": "once",
      "duration_in_months": 0,
      "id": "coup_9XKp2vQ1",
      "livemode": false,
      "max_redemptions": 0,
      "min_amount_cents": 1900,
      "object": "coupon",
      "percent_off": 0,
      "redeem_by": 0,
      "redemptions_count": 0
    }
  ],
  "has_more": false,
  "object": "list"
}