Customers

Create and manage reusable customer profiles.

A Customer is a reusable profile identified by email or phone.

Marketplaces: acting on behalf of a subaccount

Platforms can manage a connected subaccount's own customers by sending an X-Sync header alongside their own key (requires the customers capability) — see Subaccounts for the full contract and error cases.

Endpoints

Method	Path	Description
`POST`	`/customers`	Create
`GET`	`/customers/{id}`	Retrieve
`GET`	`/customers`	List
`PUT`	`/customers/{id}`	Update
`DELETE`	`/customers/{id}`	Delete

The Customer object

idstringoptional

Unique identifier.

typeenumoptional

`individual` or `business`.

emailstring?optional

Email address.

phonestring?optional

Phone number.

namestring?optional

Full name.

statusenumoptional

`active`, `inactive`, `blocked`.

metadataobjectoptional

Free-form data.

created_atdatetimeoptional

ISO 8601 creation timestamp.

PaymentsUse a customer in a payment.WebhooksReceive customer events.