A valid request URL is required to generate request examples{
"balances": [
{
"feature_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"feature_key": "<string>",
"feature_name": "<string>",
"unit_name": "<string>",
"balance": 123
}
],
"entries": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"feature_key": "<string>",
"kind": "grant",
"amount": 123,
"source": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Read a customer's credit balances
Every credit balance this customer holds — one per credit feature, folded from the ledger on demand — and the statement behind them, newest first.
The balance is never a stored number: it is the sum of every line, so what this answers is exactly what POST /v1/usage will refuse or allow. A balance may read negative while the customer is inside their plan’s overdraft.
The key’s environment scopes it — a live id asked with a test key matches no row — and there is no environment parameter, ever: the environment comes off the stored key.
A valid request URL is required to generate request examples{
"balances": [
{
"feature_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"feature_key": "<string>",
"feature_name": "<string>",
"unit_name": "<string>",
"balance": 123
}
],
"entries": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"feature_key": "<string>",
"kind": "grant",
"amount": 123,
"source": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Autorizações
An organization API key, uk_sk_live_… or uk_sk_test_…. The environment is resolved from the stored key row on every request, never from a request parameter.
Every route behind this credential is rate limited per key — 1000 requests a minute — with a second ceiling of 3000 a minute across all the keys of one environment, so splitting your traffic across keys isolates it and minting more keys does not buy more of it. A test key can never spend a live key's allowance. Every response carries the current state in headers; see the rate-limits guide.
Parâmetros de caminho
The customer.
Parâmetros de consulta
Statement lines per page.
x <= 200Statement lines to skip.