Get credit balance
GET/api/v1/credits/balance
Return the authenticated caller's organization credit balance.
The response includes total balance, pending spend locked on in-flight assessments, and the currently available amount.
- Scope required:
billing:read. - Built-in role required: owner/admin.
- Rate-limit tier: inherits the default user-read tier.
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 422
- 429
- 500
Successful Response
Bad request — malformed input or failed validation.
Missing, expired, or invalid credentials.
Authenticated but not authorized for this resource. Note: cross-organization reads return 404, not 403.
Resource not found, or hidden for tenant-enumeration safety (the caller lacks permission to know whether the resource exists).
Conflict — the current resource state does not allow this operation (e.g. assessment already started, email already in use).
Semantic validation failure — request shape was valid but contents were not.
Too many requests — rate limited. Retry after the window resets.
Internal server error — unexpected failure.