Skip to main content
Read the current wallet balance and the amount available to the API key used for the request. This is a read-only endpoint and does not accept query parameters.

​
Request

curl
The endpoint requires a standard AIsa API key in the Authorization header. It does not accept MPP payment authorization.

​
Response

All monetary values are integer microdollars. One dollar is 1,000,000 microdollars. This avoids floating-point rounding in automated clients.

​
Top-level fields

​
Balance calculation

account_balance_micros_usd is the sum of the effective cash, Trial, promo, and credit buckets. An expired Trial balance is excluded. For a limited API key, available_balance_micros_usd is the lower of the account balance and api_key.remaining_micros_usd. For an unlimited API key, it equals the account balance. The available balance is clamped at zero when the account or key balance is negative. Expired Trial credit is not included in the effective balance.

​
Errors

  • 401 Unauthorized — the API key is missing, invalid, revoked, or expired.
  • 403 Forbidden — the user is disabled or the key is not allowed from the requesting IP address.
  • 500 Internal Server Error — the balance snapshot could not be read.
Errors from this endpoint use a string-valued error field:
See Error Codes for general status-code and retry guidance, and Rate Limits for request limits.