Customers API¶
Manage customer records.
List Customers¶
GET /v1/customers
Query Parameters¶
| Parameter | Type | Description |
|---|---|---|
search |
string | Search by name or email |
limit |
number | Results per page |
offset |
number | Pagination offset |
Response¶
{
"data": [
{
"id": "cust_456",
"name": "Acme Corp",
"email": "billing@acme.com",
"created_at": "2026-01-15T08:00:00Z"
}
],
"meta": {
"total": 25
}
}
Create Customer¶
POST /v1/customers
Request Body¶
{
"name": "Acme Corp",
"email": "billing@acme.com",
"address": {
"line1": "123 Main St",
"city": "San Francisco",
"postal_code": "94102",
"country": "US"
}
}
Get Customer¶
GET /v1/customers/{id}
Update Customer¶
PATCH /v1/customers/{id}
Delete Customer¶
DELETE /v1/customers/{id}
Only customers with no invoices can be deleted.