Developers
Customers

Get a customer

GET
/customers/{id}

Returns one customer.

Authorization

apiKey
headerAuthorizationBearer <token>

A store API key from Settings → Developers → API keys, sent as Authorization: Bearer zk_live_….

Path Parameters

id*string

The resource id

Formatuuid

Response Body

Success

application/json
  1. response
object*"customer"
Value in"customer"
id*string
name*string
email*string
phone*string
source*string

How the customer joined the store

Value in"checkout""newsletter""manual"
email_status*string
Value in"valid""invalid""bounced""complained"
unsubscribed_at*string

When they opted out of marketing email; null if subscribed

tags*array<string>
created_at*string

ISO 8601 timestamp

updated_at*string

ISO 8601 timestamp

curl -X GET "https://example.com/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "object": "customer",  "id": "00000000-0000-4000-8000-0000000000c1",  "name": "Sara Ahmed",  "email": "[email protected]",  "phone": "+966500000000",  "source": "checkout",  "email_status": "valid",  "unsubscribed_at": null,  "tags": [    "vip"  ],  "created_at": "2026-09-12T14:20:00.000Z",  "updated_at": "2026-10-01T09:30:00.000Z"}

List customers GET

Lists the store's customers, newest first, with contact details and marketing status. Filter by exact email or date.

List subscriptions GET

Lists the customers' subscriptions to the store's memberships, newest first, with the plan, billing cycle, price, customer and current period. Filter by status, membership product, plan or date. Checkouts not paid yet are not included.