Passer au contenu principal
GET
/api/v1/billing/balance

Autorisations

Authorization
string
header
requis

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

Réponse

Successful response

Current balance information for the authenticated user

canConsume
boolean
requis

Whether the user has sufficient balance to make API requests

Exemple:

true

consumptionCurrency
enum<string> | null
requis

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

Options disponibles:
USD,
VCU,
DIEM,
BUNDLED_CREDITS
Exemple:

"DIEM"

balances
object
requis
diemEpochAllocation
number
requis

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

Exemple:

100