Customers
A stable identifier for the end-buyers you serve.
Overview
Attaching a customer to payments unlocks lifetime value reports, saved payment methods, and unified receipt history.
Endpoints
| Method | Path | Description |
|---|---|---|
| POST | /v1/customers | Create a customer. |
| GET | /v1/customers/{id} | Retrieve. |
| PATCH | /v1/customers/{id} | Update fields or metadata. |
| DELETE | /v1/customers/{id} | Soft delete (payments retained for audit). |
| GET | /v1/customers | List / search by email or metadata. |
POST /v1/customers
POST/v1/customers
Create a customer.
| Field | Type | Description |
|---|---|---|
email | string | Primary contact. |
phone | string | E.164 format. |
name | string | Full name. |
metadata | object | Free-form key/value. |
{ "id": "cus_01HT3P…", "email": "jean@example.ht", "created": 1794902400 }GET /v1/customers/{id}
GET/v1/customers/{id}
Retrieve.
PATCH /v1/customers/{id}
PATCH/v1/customers/{id}
Update fields or metadata.
DELETE /v1/customers/{id}
DELETE/v1/customers/{id}
Soft delete (payments retained for audit).
GET /v1/customers
GET/v1/customers
List / search by email or metadata.