5 endpoints
Clients
The registry of your end customers — name, e-mail, phone — reused by subscriptions: each instalment's payment link is sent to the customer's e-mail address.
Endpoint names and descriptions come from the OpenAPI contract, in English — they cannot drift from the API.
You create your test key in the portal as soon as your account is activated.
In plain English
Your customer directory, with the contact details the payment links are sent to.
When to use it
Whenever you want to recognise a customer from one payment to the next: subscriptions, or simply a per-customer history.
How to integrate it
- 1Create the customer once, with their e-mail address, and keep their identifier on your side.
- 2Attach their subscriptions: every instalment is sent to that address.
- 3Update their details when they change: the next links follow.
- 4Delete the customer once they have no active subscription left: it is their data, not yours.
- GET
/v1/clients/{id}Retrieve a client - PUT
/v1/clients/{id}Update a client - DELETE
/v1/clients/{id}Delete a client - GET
/v1/clientsList clients - POST
/v1/clientsCreate a client
Retrieve a client
Fetches a single client by its UUID.
| Field | Type | In | Required | Description |
|---|---|---|---|---|
id | string (uuid) | path | Required | Client UUID. |
Update a client
Updates a client's name, e-mail and/or phone.
Schema · UpdateClientRequest
| Field | Type | In | Required | Description |
|---|---|---|---|---|
id | string (uuid) | path | Required | |
name | string | body | Optional | Client full name. Optional; only applied when present. |
email | string | body | Optional | Client email address. Optional; only applied when present. |
phone | string | body | Optional | Client phone number. Optional; only applied when present. |
Delete a client
Deletes a client. Returns 204 No Content. Fails if the client still has active subscriptions.
| Field | Type | In | Required | Description |
|---|---|---|---|---|
id | string (uuid) | path | Required |
List clients
Returns the account's saved clients as a paginated Page.
| Field | Type | In | Required | Description |
|---|---|---|---|---|
origin | enum | query | Optional | Filter by creation origin (API or DASHBOARD).Values APIDASHBOARD |
pageable | Pageable | query | Required |
Create a client
Creates a reusable customer record for this account.
Schema · CreateClientRequest
| Field | Type | In | Required | Description |
|---|---|---|---|---|
name | string | body | Required | Client full name. |
email | string | body | Optional | Optional client e-mail. |
phone | string | body | Optional | Optional client phone (E.164). |
Make your first test-mode call
Create your account, generate your test key in the portal and send your first request today — or talk to an integrator.
- Free, no commitment
- Test mode from sign-up
- No approval to wait for