Skip to main content
GET https://sys.poixe.com/api/account/balance
Returns the total balance and the user level of the current account. This endpoint is commonly used to:
  • Check the balance periodically from your own monitoring or alerting system, and get notified when it runs low
  • Display the account balance in an internal admin dashboard
This endpoint uses a system token (starts with sys-) and the sys.poixe.com domain. API tokens (business tokens) starting with sk- cannot call it. See System Tokens for how to create one and how it differs from an API token.

Authentication and headers

string
required
Bearer token. The format is Bearer YOUR_SYSTEM_TOKEN, where the token starts with sys-.
string
Optional. If set, use application/json.

Response structure

number
Total account balance (in USD).
integer
The user level.
integer
The time the response was generated (Unix timestamp in seconds).

Error responses

See the System APIs overview for more.