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

​
GTM fields

​
Balance calculation

The PAYG balance is the sum of the effective cash, Trial, promo, and credit buckets. An expired Trial balance is excluded. go_to_market_balance_micros_usd is the GTM balance. It is also exposed as gtm.balance_micros_usd, with its trial and subscription components in the gtm object. account_balance_micros_usd is the PAYG balance plus go_to_market_balance_micros_usd. For a limited API key, available_balance_micros_usd is the lower of the PAYG balance and api_key.remaining_micros_usd, plus the GTM balance. For an unlimited API key, it equals the PAYG balance plus the GTM balance. The PAYG portion available to the key is clamped at zero when the PAYG 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.