v1

latestOpenAPI 3.1.02026-07-2656258207.2 KB
Customer

List customers

get/customers

Query parameters

pageinteger

The page of the data to retrieve. The most recent data entry is on page 1.

sizeinteger

Length of data returned. Defaults to 10.

Headers

X-Trace-Idstring

A unique identifier to track this operation. It must be between 12 and 255 characters in length.

Response

OK

status'success' | 'failed'
messagestring

Example response

{
  "data": [
    {
      "id": "cus_3XarBILKQS",
      "address": {
        "city": "New York",
        "country": "US",
        "line1": "123 Main Street",
        "line2": "Apt 4B",
        "postal_code": "10001",
        "state": "New York"
      },
      "email": "cornelius@gmail.com",
      "name": {
        "first": "King",
        "middle": "Leo",
        "last": "LeBron"
      },
      "phone": {
        "country_code": "234",
        "number": "08012345678"
      }
    }
  ]
}
All 61 operations