v1

latestOpenAPI 3.1.02026-07-24233206489.1 KB
Customers (v1)

List Customers

Retrieve all customers for the account, with optional filtering by email or phone number

get/v1/customers

Query parameters

emailstring

Filter by email

phone_numberstring

Filter by phone number

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "created_at": 1710000000,
        "default_device": "email",
        "email": "john@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "livemode": true,
        "phone": "+639171234567",
        "updated_at": 1710000000
      },
      "id": "cus_abc123",
      "type": "customer"
    }
  ]
}