Platform Guides
Billing & Usage
Manage wallets, fund accounts with top-ups, and track metered platform usage.
Overview
Billing is wallet-based. Each account holds one or more wallets with a balance in a given currency. Platform activity draws down the wallet according to unit configuration — the price book that maps billable events to costs. Funds are added through top-ups, and every charge is recorded as a usage record.
Wallets
A wallet is the unit of funding. Read a wallet to see its current balance and currency before starting billable work.
| GET | /api/v1/wallets | List wallets for the account. |
| GET | /api/v1/wallets/{id} | Retrieve a wallet and its balance. |
Top-ups
A top-up credits a wallet. Create a top-up to begin a payment, then poll it until its status settles to completed.
| POST | /api/v1/topups | Start a top-up against a wallet. |
| GET | /api/v1/topups | List top-ups and their status. |
| GET | /api/v1/topups/{id} | Retrieve a single top-up. |
Usage
Usage records are the itemized ledger of what was charged. Filter by date range to reconcile spend or build cost dashboards.
| GET | /api/v1/usage | List usage records, filterable by date range. |
| GET | /api/v1/usage/summary | Aggregated usage totals for a period. |
Unit configuration
Unit configuration defines the per-event prices applied to usage. These endpoints are typically admin-only — read them to understand how charges are derived.
| GET | /api/v1/unit-configs | List configured billing units and prices. |
See the full schema and parameters in the Label Backend API reference.