Get Balance

View as Markdown
Return the credit balance for the authenticated caller. Authenticate with an rsk_ API key. If the key belongs to an organization, the organization's shared balance is returned — all members of an org share the same billing pool; a key with no org gets its own balance. The response also reports how much of the balance is reserved by in-flight operations (`reserved_usd`, plus a per-category `reserved_breakdown`) and the spendable remainder (`available_usd`).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Successful Response
balance_usdstring
Total credit balance in USD.
available_usdstring

Spendable balance: balance_usd minus reserved_usd.

reserved_usdstringDefaults to 0.0000000

Funds currently held by in-flight operations and not spendable.

updated_atstring or null

Last balance update (ISO 8601).

messagestring or null