Skip to content

Get credit balance, reserved, available, and buffer status

GET
/api/v1/billing/credits
curl --request GET \
--url https://api.ultimateteam.ai/api/v1/billing/credits \
--header 'X-API-Key: <X-API-Key>'

Return the tenant’s current credit balance, reserved (escrowed) credits, available (= balance - reserved), per-tier minimum buffer, and a traffic-light status.

Successful Response

Media typeapplication/json
CreditsResponse

Response schema for credit balance and usage.

Attributes: data: Credit balance payload.

object
data
Data
object
key
additional properties
any
Examplegenerated
{
"data": {}
}