Customers

List customers

Changed on

List customers with optional pagination and search filtering.

get/api/v1/customers

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

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"
        }
      }
    }
  ]
}

Changes

  • v15cb340234766Revision changes
    • info

      added the new optional query request parameter order_by

  • v1de35c02bb0d2Revision changes
    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status