REST

Customers

Create, read and update customer records.

Customer records are the root of every billing relationship. This page is a placeholder for the customer endpoints.

List customers#

GET/v1/customers

Returns a paginated list of customers for the tenant.

Parameter	Type	Notes
`limit`	number	Page size, 1 to 100
`cursor`	string	Cursor from the previous page
`email`	string	Exact-match filter

curl -H "Authorization: Bearer $VERLIX_API_KEY" \
  "https://api.verlix.example/v1/customers?limit=25"

POST/v1/customers

Creates a customer. Requires the customers:write scope.

{
    "name": "Brightline Logistics",
    "email": "billing@brightline.example",
    "currency": "usd"
}

Email is the identity

Two customers with the same email in one tenant are rejected with a conflict. Match on email before you create.

PATCH/v1/customers/{id}

Updates the mutable fields of one customer.

Field	Type	Notes
`name`	string	Display name
`email`	string	Must remain unique in the tenant
`currency`	string	ISO 4217 code

A customer with issued invoices cannot be deleted. Void the invoices first, or archive the customer instead.