BillKit/Docs Console
Customers

List customers

List your customers, newest first.

GET/v1/customers
Operation list_customers · Scope customers:read · Spec snapshot 2026-09-13

Parameters

ParameterDescription
provisionalboolean | null · queryoptionalFilter by whether the customer ever completed a payment. `false` returns real customers only; `true` returns abandoned checkouts (useful for cart-recovery email); omit to return both.
limitinteger · queryoptionalDefaults to 10. Between 1 and 100.
starting_afterstring | null · queryoptionalAt most 128 characters.
expandstring | null · queryoptionalAt most 256 characters.

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

Returns

Returns a page of CustomerResponse 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

Status Cause
401 Missing or invalid API key.
403 Key is missing the customers:read scope.
422 Validation Error
429 Rate limited. Back off and retry.
Request · curl 
curl -X GET https://api.billkit.eu/v1/customers \
  -H "Authorization: Bearer $BILLKIT_SECRET_KEY"
Response · 200 OK 
{
  "data": [
    {
      "country_code": "NL",
      "created": 1789392000,
      "email": "ada@example.com",
      "id": "cus_9XKp2vQ1",
      "livemode": false,
      "metadata": {
        "key": "value"
      },
      "name": "Ada Lovelace",
      "object": "customer",
      "provisional": false,
      "stats": {
        "currency": "EUR",
        "lifetime_cents": 1900,
        "object": "customer.stats",
        "subscription_count": 0
      },
      "test_clock": "string",
      "vat_number": "string",
      "vat_number_validated": false
    }
  ],
  "has_more": false,
  "object": "list"
}