GET
/api/v1/households/{householdId}/usageGet the household's AI credits for the current billing period
Any household member. Credits, never tokens or cost (SUBS.md §23–24): used, limit, remaining and bonus, the soft/allowance-spent/hard flags the apps warn on, and what one chat turn costs (#418). Reading rolls the period forward when it has ended but never spends anything.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
householdId | path | string (uuid) | Required | — |
Responses
- 200OK
application/jsonUsageResponse- 401No session, or the session is no longer valid.
application/problem+jsonProblemDetails- 404Not Found
application/problem+jsonProblemDetails- 426The build named in X-App-Version is below its platform's version floor (ADR-070). Problem type app-version-unsupported; the only way forward is the store. Callers without the header are never turned away.
application/problem+jsonProblemDetails- 429Too many calls in the window; Retry-After says how long.
application/problem+jsonProblemDetails- Headers
Retry-After- — Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.
- 503The server is down for maintenance (#4693). Retry-After says when to try again; problem type maintenance. Every call under /api answers this while maintenance mode is on, the version floor included.
application/problem+jsonProblemDetails- Headers
Retry-After- — Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.
Example
curl -b "bryti_session=…" \
"https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/usage"Example response
200
application/json{
"period": {
"startsAt": "2026-09-07T16:30:00Z",
"endsAt": "2026-09-07T16:30:00Z"
},
"credits": {
"used": 0,
"limit": 0,
"remaining": 0,
"percentage": 0,
"bonus": 0,
"bonusGranted": 0,
"welcomeRemaining": 0,
"monthlyRemaining": 0,
"drawsFrom": {},
"hardLimit": 0
},
"limits": {
"softLimitReached": false,
"allowanceSpent": false,
"hardLimitReached": false
},
"plan": {
"code": "string",
"name": "string"
},
"chatTurnCredits": 0
}