TOtopograph
Billing

Get the current account credit balance

Returns the account's remaining credit balance, a derived health status, the auto-topup posture, and the configured low-balance thresholds. This is the remaining balance — for consumption use GET /v2/workspaces/usage.

get/v2/billing/balance

Request

  • Base URL
    https://api.topograph.co
  • URL
    https://api.topograph.co/v2/billing/balance
  • Auth
    API key in header x-api-key

Response

balanceInCreditCentsnumber required

Current remaining account balance, in credit cents.

status'ok' | 'low' | 'depleted' required

Derived health of the balance. depleted when the balance is at or below zero (new work is blocked); low when it is at or below the highest configured low-balance threshold; otherwise ok.

Example response

{
  "balanceInCreditCents": 42350,
  "status": "ok",
  "autoTopup": {
    "enabled": true,
    "thresholdInCreditCents": 5000,
    "amountInCreditCents": 10000
  },
  "lowBalanceThresholds": [
    {
      "tier": "warning",
      "cents": 100000
    }
  ]
}

Changes

No recorded changes to this operation across all 50 revisions of this API.