Skip to main content

Customers

The Customers API lets you read your store's customers and their purchase history.

Overview​

The Customers API provides endpoints to:

A customer is a person who has bought from your store, or who holds access to one of its products or subscriptions — including access delegated to them by another buyer, such as one seat of a multi-seat purchase. The API is read-only — customer name and email are login identity and cannot be edited through the API.

Currency scope​

Customers, their lifetime value, and their order history are tracked per currency — a customer whose orders and access are all priced in USD does not appear when you ask for EUR. For this reason every endpoint requires a currency query parameter. See Get Store for the currencies your store transacts in.

Lifetime value, order counts, and the order list cover only the customer's own orders. A customer who holds access in a currency but has never ordered in it — for example, the recipient of a delegated seat — has no orders and no lifetime value in that currency.

currency scopes the money sections only (lifetime value, order counts, and the order list). Subscriptions and one-time product access are store-scoped, not per currency, so they are returned regardless of the currency you pass.