Customers API

List Customers

GET /v1/customers

Query Parameters:

Parameter	Type	Description
page	number	Page number (default: 1)
limit	number	Items per page (default: 20)
search	string	Search by name or email

Response:

{
  "success": true,
  "data": [
    {
      "id": "cust_abc123",
      "email": "jane@example.com",
      "name": "Jane Doe",
      "externalId": "user_456",
      "metadata": {},
      "createdAt": "2025-01-15T10:30:00Z"
    }
  ],
  "pagination": { "page": 1, "limit": 20, "total": 42 }
}

Get Customer

GET /v1/customers/{id}

Create Customer

POST /v1/customers

Request Body:

{
  "email": "jane@example.com",
  "name": "Jane Doe",
  "externalId": "user_456",
  "metadata": {
    "tier": "gold"
  }
}

Field	Type	Required	Description
email	string	Yes	Customer email
name	string	No	Display name
externalId	string	No	Your system’s user ID
metadata	object	No	Custom key-value data

Update Customer

PATCH /v1/customers/{id}

Request Body:

{
  "name": "Jane Smith",
  "metadata": {
    "tier": "platinum"
  }
}

Delete Customer

DELETE /v1/customers/{id}

Returns 204 No Content on success.