BillKit/DocsConsole
Customers

List customers

List your customers, newest first.

GET/v1/customers
Operation list_customers·Scope customers:read·OpenAPI v1.1.0

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 · 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.
expandstring | null · queryoptionalComma-separated related objects to include in the response. Expandable here: stats. An unknown name is a 400, and embedding another resource needs that resource's read scope. At 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

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 customers: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/customers \
  -H "Authorization: Bearer $BILLKIT_API_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_id": "tc_9XKp2vQ1",
      "vat_number": "string",
      "vat_number_validated": false
    }
  ],
  "has_more": false,
  "object": "list"
}