Skip to main content
GET
/
v2
/
billing
/
balance
Get the current account credit balance
curl --request GET \
  --url https://api.topograph.co/v2/billing/balance \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.topograph.co/v2/billing/balance"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.topograph.co/v2/billing/balance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.topograph.co/v2/billing/balance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.topograph.co/v2/billing/balance"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.topograph.co/v2/billing/balance")
  .header("x-api-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.topograph.co/v2/billing/balance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "balanceInCreditCents": 42350,
  "status": "ok",
  "autoTopup": {
    "enabled": true,
    "thresholdInCreditCents": 5000,
    "amountInCreditCents": 10000
  },
  "lowBalanceThresholds": [
    {
      "tier": "warning",
      "cents": 100000
    }
  ]
}

Authorizations

x-api-key
string
header
required

Response

200 - application/json
balanceInCreditCents
number
required

Current remaining account balance, in credit cents.

Example:

42350

status
enum<string>
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.

Available options:
ok,
low,
depleted
Example:

"ok"

autoTopup
object
required

Read-only auto-topup posture for the account.

lowBalanceThresholds
object[]
required

Resolved low-balance thresholds. A low_balance notification fires when the balance drops at or below a tier. Returned here so a client can interpret status and surface the same thresholds it is alerted on.