Read the account credit balance, spend-based runway estimate and any credit notice

The account's current credit balance, plus runway (an estimate of how many days the balance lasts at the current spend rate) and notice (the same notice shown on the portal's overview page, null when there is none) - both ADDITIVE, so a client that only reads balanceHal/balanceCzk/currency keeps working. Also topupBalanceHal (the topped-up part, negative when the account owes) and subscription (the monthly plan, or null): balanceHal stays the TOTAL of the monthly plan credit and the topped-up credit.

get/v1/balance

Request

  • Base URL: https://volai.cz
  • URL: https://volai.cz/v1/balance
  • Auth: HTTP bearer

Response

Current balance with runway and notice

balanceHalnumber required

Total credit in hellers: the monthly plan credit that is left plus the topped-up credit. Negative when the topped-up credit is in debt.

balanceCzknumber required
currency'CZK' required
topupBalanceHalnumber required

The topped-up part of balanceHal in hellers: top-ups, bonus and adjustments. It does not expire. Negative when the account owes (debt); the monthly plan credit is never negative.

Changes

No recorded changes to this operation across all 1 revision of this API.