v1

latestOpenAPI 3.1.0AGPL-3.0-only2026-07-1773264353.7 KB

Customers

List customers

List customers with optional pagination and search filtering.

get/api/v1/customers

Query parameters

order_bystring

Sort order. Format: column.direction. Allowed columns: name, email, alias, created_at. Direction: asc or desc. Default: created_at.desc.

pageinteger

Page number (0-indexed)

per_pageinteger

Number of items per page

searchstring

archivedboolean

Response

List of customers

Example response

{
  "data": [
    {
      "billing_address": {
        "country": "US"
      },
      "currency": "EUR",
      "id": "cus_7n42DGM5Tflk9n8mt7Fhc7",
      "invoicing_entity_id": "ive_7n42DGM5Tflk9n8mt7Fhc7",
      "shipping_address": {
        "address": {
          "country": "US"
        }
      }
    }
  ]
}