v1

latestOpenAPI 3.0.02026-07-263365201.7 KB

Customers

List customers

Retrieve all customers with cursor pagination

get/customers

Query parameters

cursorstring nullable

limitnumber

filter[field][operator]string nullable

Filterable fields:

email (string)
type (string)
created_at (date)

See Filtering Documentation for supported operators and syntax.

Example:value

Filterable fields:

email (string)
type (string)
created_at (date)

See Filtering Documentation for supported operators and syntax.

Response

Retrieve all customers with cursor pagination

object'list' required

next_pagestring nullable

has_moreboolean

Example response

{
  "items": [
    {
      "id": "cus_mi4f0oda6x9m7gcsvjk0ole1",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@example.com",
      "vat_id": "DE123456789"
    }
  ],
  "next_page": "eyJsYXN0X2NyZWF0ZWRfYXQiOiIyMDI1LTAxLTE1VDEwOjMwOjAwLjAwMFoiLCJsYXN0X2lkIjoic3ViX21pNGYwb2RhNng5bTdnY3N2amswb2xlMSIsImxpbWl0IjoyMH0="
}