Skip to content

Check Balance

Query your credit balance and spending.

Request

GET /v1/balance

Auth: API Key (Authorization: Bearer ucm_key_...)

Response

200 OK

json
{
  "agent_id": "abc123...",
  "credits": {
    "balance": "0.95",
    "lifetime_added": "1.00",
    "lifetime_spent": "0.05",
    "currency": "USD"
  }
}

Fields

FieldDescription
credits.balanceCurrent available credits
credits.lifetime_addedTotal credits ever added (registration + bonuses + redemptions)
credits.lifetime_spentTotal credits spent on service calls
credits.currencyAlways "USD"