8 endpoints
Clients
The registry of your end customers and their saved payment methods, reused for subscriptions and recurring charges without re-entering details.
Endpoint names and descriptions come from the OpenAPI contract, in English — they cannot drift from the API.
In plain English
Your customer directory, and the cards they agreed to save.
When to use it
Whenever you want to recognise a customer from one payment to the next: recurring billing, a saved card reused by subscriptions, or simply a per-customer history.
How to integrate it
- 1Create the client once, keep their id on your side.
- 2List their saved payment methods so you can offer them a repeat payment without re-entering a card.
- 3Set a default method — that is the one a subscription will charge.
- 4Delete a payment method as soon as the customer asks: 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 - POST
/v1/clients/{id}/payment-methods/{paymentMethodId}/defaultSet a client's default payment method - GET
/v1/clientsList clients - POST
/v1/clientsCreate a client - GET
/v1/clients/{id}/payment-methodsList a client's saved payment methods - DELETE
/v1/clients/{id}/payment-methods/{paymentMethodId}Delete a client's payment method
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 |
Set a client's default payment method
Marks one client-owned payment method as the default for new auto-pay subscriptions.
| Field | Type | In | Required | Description |
|---|---|---|---|---|
id | string (uuid) | path | Required | |
paymentMethodId | 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). |
List a client's saved payment methods
Returns safe local payment-method identifiers and masked card metadata. Provider card tokens, CVV plaintext and CVV ciphertext are never returned.
| Field | Type | In | Required | Description |
|---|---|---|---|---|
id | string (uuid) | path | Required |
Delete a client's payment method
Deletes the provider token and soft-deletes its local mirror. Subscriptions using it fall back to customer-present checkout on their next attempt.
| Field | Type | In | Required | Description |
|---|---|---|---|---|
id | string (uuid) | path | Required | |
paymentMethodId | string (uuid) | path | Required |
A question about integration?
Our technical team supports integrators from the first sandbox call through to go-live.