API Reference
API overview
Base URL, versioning, pagination and the shape of every response.
The API is a JSON over HTTPS interface. This page is a placeholder for the conventions every endpoint shares.
Base URL#
https://api.verlix.example/v1Versioning#
The major version is in the path. A breaking change ships as a new path segment; an additive change ships in place.
Pin the version
Always pin the major version in your client. An unpinned client will one day receive a response it does not understand.
Pagination#
List endpoints are cursor-paginated. Pass limit and follow nextCursor until it is null.
GET
/v1/customers?limit=25Returns one page of customers and a cursor for the next page.
| Parameter | Type | Default | Notes |
|---|---|---|---|
limit | number | 25 | Between 1 and 100 |
cursor | string | — | Opaque; from the previous page |
Request and response format#
POST /v1/invoices HTTP/1.1
Content-Type: application/json
Authorization: Bearer vx_live_...
Idempotency-Key: 6f1c...
{"customerId": "cus_01H...", "currency": "usd"}Errors#
Every error uses the envelope described in the errors guide. The code is stable; the message is for humans and may change.