Skip to main content
GET
Returns the account AI credit wallet: total, remaining, and used credits, each with its USD equivalent at the account rate of 1000 credits = $1. The response also includes the currency, the conversion rate, and the last time balances were synced.
This endpoint is restricted to account owners and billing managers. The API key must belong to a user with the client_owner or client_accessBillings role, otherwise the request is rejected with 403.

Authorizations

This endpoint requires API key authentication. Include your API key in the request header:
  • Header name: X-Api-Key
  • Header value: Your API key from the Ollang dashboard
  • Format: X-Api-Key: your-api-key-here
You can obtain your API key from your Ollang dashboard. The key must belong to a user with the client_owner or client_accessBillings role. Requests from keys without one of these billing roles are rejected with 403.

Response

number
Total AI credits assigned to the account (active + depleted). Unit: credits.
number
Currently remaining AI credits. Unit: credits.
number
AI credits consumed so far. Unit: credits.
string
Currency the credits convert to (for example USD).
number
Conversion rate: credits per one unit of currency (for example 1000).
number
Total credits expressed in USD (totalCredits / 1000).
number
Remaining credits expressed in USD (remainingCredits / 1000).
number
Used credits expressed in USD (usedCredits / 1000).
string
Last time credit balances were synced (ISO 8601 format), or null if never synced.