List Customers
Active customers, newest first. With `external_ref` alone: the exact reference match, or 404 not_found. `external_ref` cannot be combined with list filters, `q` or a cursor. `q` (1–128 characters) matches an exact customer ID or full normalized contact email via retained blind-index keys; other queries match part of a name or contact email, case-insensitively; a search page may be short or empty with `has_more: true` — keep following `next_cursor`. Searches use the `customer_search` rate bucket and refuse Idempotency-Key.
/customersActive customers, newest first. With external_ref alone: the exact reference match, or 404 not_found. external_ref cannot be combined with list filters, q or a cursor. q (1–128 characters) matches an exact customer ID or full normalized contact email via retained blind-index keys; other queries match part of a name or contact email, case-insensitively; a search page may be short or empty with has_more: true — keep following next_cursor. Searches use the customer_search rate bucket and refuse Idempotency-Key.
In: header
Query Parameters
Opaque signed cursor. Return it unchanged; valid for 24 hours.
1 <= length <= 81921 <= value <= 10050^[A-Za-z0-9_.:-]{1,128}$1 <= length <= 512RFC 3339 UTC timestamp; only the Z suffix is accepted.
date-timeRFC 3339 UTC timestamp; only the Z suffix is accepted.
date-timeResponse Body
application/json
application/json
application/json
curl -X GET "https://example.com/customers"{ "data": [ { "id": "string", "external_ref": "string", "created": "2019-08-24T14:15:22Z", "email": "string", "name": "string", "metadata": { "property1": null, "property2": null }, "country": "string", "address": { "line1": "string", "line2": "string", "city": "string", "state": "string", "postal_code": "string", "country": "string" } } ], "pagination": { "next_cursor": "string", "has_more": true, "as_of": "2019-08-24T14:15:22Z" }, "request_id": "266ea41d-adf5-480b-af50-15b940c2b846", "source": "primary"}List Customer Entitlements GET
Current access for the customer, including gifts received, evaluated from recorded windows. Ordered by entitlement id ascending. Product name and reference identify the access; a null paid_through does not imply lifetime access.
List Disputes GET
Synced disputes, newest opened first. Groups: needs_response awaits the merchant (including an inquiry whose deadline is still open); stopped_early holds prevented alerts; paypal holds PayPal cases; disputes holds every other case. Customer name/email are included only with customers:read.