Customers API
Manage customer profiles, billing information, and subscriptions.
List Customers
GET /api/customersReturns all customers with their associated products.
Response 200 OK
[
{
"id": "01JQX...",
"name": "Acme Corp",
"email": "billing@acme.com",
"company": "Acme Corporation",
"tier": "professional",
"billingAddress": "123 Main St, Suite 400",
"taxId": "US12345678",
"paymentMethod": "stripe",
"healthScore": 85,
"creditBalance": "150.00",
"createdAt": "2026-01-15T10:30:00Z",
"updatedAt": "2026-01-15T10:30:00Z"
}
]Get Customer
GET /api/customers/:idReturns a single customer with their products and subscriptions.
Create Customer
POST /api/customers
Content-Type: application/jsonBody
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Customer name |
email | string | Yes | Unique email address |
company | string | No | Company name |
tier | string | No | starter, professional, or enterprise |
billingAddress | string | No | Billing address |
taxId | string | No | Tax identifier |
paymentMethod | string | No | Default payment method |
Response 201 Created
Update Customer
PUT /api/customers/:id
Content-Type: application/jsonResponse 200 OK
Delete Customer
DELETE /api/customers/:idResponse 204 No Content
Search Customers
GET /api/search/customers?q=acmeFull-text search across customer name, email, and company fields.
Last updated on