Account account
The current users own balance and freeze status; admins manage other users accounts through the user account endpoints.
Pick an endpoint to see its example call on the right.
Authentication
Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.
X-API-Key
Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).
Conventions
Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.
Times are RFC 3339 (UTC); amounts are in cents.
Writes return 200/201/204 on success; duplicates of a unique key return 409.
/api/v2/accountGet my account
Authentication: User
/api/v2/account/currencyChange my account currency
Authentication: User
Request body application/json
| Field | Type | Description |
|---|---|---|
currencyRequired | string | Account currency (ISO 4217); balance, recharges and deductions are all kept in it. |
Account object
| Field | Type | Description |
|---|---|---|
active_packages | integer | Number of active packages (end_at in the future; one of the blockers for changing the account currency). Only the admin GET /users/{user_id}/account returns it. |
balance_cents | integer | Account balance in cents. |
currencies | AccountCurrencyOption[] | Selectable enabled currencies (base first, then by code); only present when currency_changeable is true, only in GET /account and the admin GET /users/{user_id}/account. |
currency | string | Account currency (ISO 4217); balance, recharges and deductions are all kept in it. |
currency_changeable | boolean | Whether the tenant can change the account currency now (zero balance, no unpaid orders, no active packages). Only GET /account and the admin GET /users/{user_id}/account return it. |
default_currency | string | Default account currency for new users (ISO 4217); lets the tenant UI tell whether the account currency was never changed (only then is it preselected by UI language). Sent together with currencies, only when currency_changeable is true, only in GET /account and the admin GET /users/{user_id}/account. |
freeze_reason | string | Freeze reason; empty if not frozen. |
frozen | boolean | Whether the account is frozen; deductions are rejected while frozen. |
unpaid_orders | integer | Number of unpaid orders (one of the blockers for changing the account currency). Only the admin GET /users/{user_id}/account returns it. |
updated_at | string | Updated at |
user_id | integer | User ID |
Responses and errors
Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.
{
"id": 1,
"name": "example"
}{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}{
"code": "validation_failed",
"detail": "Invalid request parameters",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name is required"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}