Skip to main content
GET
/api/v1/billing/balance

Authorizations

Authorization
string
header
required

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

Response

Successful response

Current balance information for the authenticated user

canConsume
boolean
required

Whether the user has sufficient balance to make API requests

Example:

true

consumptionCurrency
enum<string> | null
required

The currency that will be used for consumption (DIEM or USD)

Available options:
USD,
VCU,
DIEM,
BUNDLED_CREDITS
Example:

"DIEM"

balances
object
required
diemEpochAllocation
number
required

Total DIEM allocation for the current epoch (from staking). Use with balances.diem to calculate usage percentage.

Example:

100