Upsert billing notification config
curl --request PATCH \
--url https://api.topograph.co/v2/billing/notifications/config \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"lowBalanceEnabled": true,
"lowBalanceEmailEnabled": true,
"lowBalanceWebhookEnabled": true,
"lowBalanceTiers": [
{
"tier": "warning",
"cents": 100000
}
],
"globalHighUsageEnabled": false,
"globalHighUsageEmailEnabled": true,
"globalHighUsageWebhookEnabled": true,
"globalHighUsagePeriodMinutes": 1440,
"globalHighUsageTiers": [
{
"tier": "warning",
"cents": 100000
}
],
"highUsageEnabled": false,
"highUsageEmailEnabled": true,
"highUsageWebhookEnabled": true,
"highUsagePeriodMinutes": 1440,
"highUsageTiers": [
{
"tier": "warning",
"cents": 100000
}
],
"autoTopupNotificationsEnabled": false,
"autoTopupEmailEnabled": true,
"autoTopupWebhookEnabled": true
}
'import requests
url = "https://api.topograph.co/v2/billing/notifications/config"
payload = {
"lowBalanceEnabled": True,
"lowBalanceEmailEnabled": True,
"lowBalanceWebhookEnabled": True,
"lowBalanceTiers": [
{
"tier": "warning",
"cents": 100000
}
],
"globalHighUsageEnabled": False,
"globalHighUsageEmailEnabled": True,
"globalHighUsageWebhookEnabled": True,
"globalHighUsagePeriodMinutes": 1440,
"globalHighUsageTiers": [
{
"tier": "warning",
"cents": 100000
}
],
"highUsageEnabled": False,
"highUsageEmailEnabled": True,
"highUsageWebhookEnabled": True,
"highUsagePeriodMinutes": 1440,
"highUsageTiers": [
{
"tier": "warning",
"cents": 100000
}
],
"autoTopupNotificationsEnabled": False,
"autoTopupEmailEnabled": True,
"autoTopupWebhookEnabled": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
lowBalanceEnabled: true,
lowBalanceEmailEnabled: true,
lowBalanceWebhookEnabled: true,
lowBalanceTiers: [{tier: 'warning', cents: 100000}],
globalHighUsageEnabled: false,
globalHighUsageEmailEnabled: true,
globalHighUsageWebhookEnabled: true,
globalHighUsagePeriodMinutes: 1440,
globalHighUsageTiers: [{tier: 'warning', cents: 100000}],
highUsageEnabled: false,
highUsageEmailEnabled: true,
highUsageWebhookEnabled: true,
highUsagePeriodMinutes: 1440,
highUsageTiers: [{tier: 'warning', cents: 100000}],
autoTopupNotificationsEnabled: false,
autoTopupEmailEnabled: true,
autoTopupWebhookEnabled: true
})
};
fetch('https://api.topograph.co/v2/billing/notifications/config', 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/notifications/config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'lowBalanceEnabled' => true,
'lowBalanceEmailEnabled' => true,
'lowBalanceWebhookEnabled' => true,
'lowBalanceTiers' => [
[
'tier' => 'warning',
'cents' => 100000
]
],
'globalHighUsageEnabled' => false,
'globalHighUsageEmailEnabled' => true,
'globalHighUsageWebhookEnabled' => true,
'globalHighUsagePeriodMinutes' => 1440,
'globalHighUsageTiers' => [
[
'tier' => 'warning',
'cents' => 100000
]
],
'highUsageEnabled' => false,
'highUsageEmailEnabled' => true,
'highUsageWebhookEnabled' => true,
'highUsagePeriodMinutes' => 1440,
'highUsageTiers' => [
[
'tier' => 'warning',
'cents' => 100000
]
],
'autoTopupNotificationsEnabled' => false,
'autoTopupEmailEnabled' => true,
'autoTopupWebhookEnabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.topograph.co/v2/billing/notifications/config"
payload := strings.NewReader("{\n \"lowBalanceEnabled\": true,\n \"lowBalanceEmailEnabled\": true,\n \"lowBalanceWebhookEnabled\": true,\n \"lowBalanceTiers\": [\n {\n \"tier\": \"warning\",\n \"cents\": 100000\n }\n ],\n \"globalHighUsageEnabled\": false,\n \"globalHighUsageEmailEnabled\": true,\n \"globalHighUsageWebhookEnabled\": true,\n \"globalHighUsagePeriodMinutes\": 1440,\n \"globalHighUsageTiers\": [\n {\n \"tier\": \"warning\",\n \"cents\": 100000\n }\n ],\n \"highUsageEnabled\": false,\n \"highUsageEmailEnabled\": true,\n \"highUsageWebhookEnabled\": true,\n \"highUsagePeriodMinutes\": 1440,\n \"highUsageTiers\": [\n {\n \"tier\": \"warning\",\n \"cents\": 100000\n }\n ],\n \"autoTopupNotificationsEnabled\": false,\n \"autoTopupEmailEnabled\": true,\n \"autoTopupWebhookEnabled\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.topograph.co/v2/billing/notifications/config")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"lowBalanceEnabled\": true,\n \"lowBalanceEmailEnabled\": true,\n \"lowBalanceWebhookEnabled\": true,\n \"lowBalanceTiers\": [\n {\n \"tier\": \"warning\",\n \"cents\": 100000\n }\n ],\n \"globalHighUsageEnabled\": false,\n \"globalHighUsageEmailEnabled\": true,\n \"globalHighUsageWebhookEnabled\": true,\n \"globalHighUsagePeriodMinutes\": 1440,\n \"globalHighUsageTiers\": [\n {\n \"tier\": \"warning\",\n \"cents\": 100000\n }\n ],\n \"highUsageEnabled\": false,\n \"highUsageEmailEnabled\": true,\n \"highUsageWebhookEnabled\": true,\n \"highUsagePeriodMinutes\": 1440,\n \"highUsageTiers\": [\n {\n \"tier\": \"warning\",\n \"cents\": 100000\n }\n ],\n \"autoTopupNotificationsEnabled\": false,\n \"autoTopupEmailEnabled\": true,\n \"autoTopupWebhookEnabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.topograph.co/v2/billing/notifications/config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"lowBalanceEnabled\": true,\n \"lowBalanceEmailEnabled\": true,\n \"lowBalanceWebhookEnabled\": true,\n \"lowBalanceTiers\": [\n {\n \"tier\": \"warning\",\n \"cents\": 100000\n }\n ],\n \"globalHighUsageEnabled\": false,\n \"globalHighUsageEmailEnabled\": true,\n \"globalHighUsageWebhookEnabled\": true,\n \"globalHighUsagePeriodMinutes\": 1440,\n \"globalHighUsageTiers\": [\n {\n \"tier\": \"warning\",\n \"cents\": 100000\n }\n ],\n \"highUsageEnabled\": false,\n \"highUsageEmailEnabled\": true,\n \"highUsageWebhookEnabled\": true,\n \"highUsagePeriodMinutes\": 1440,\n \"highUsageTiers\": [\n {\n \"tier\": \"warning\",\n \"cents\": 100000\n }\n ],\n \"autoTopupNotificationsEnabled\": false,\n \"autoTopupEmailEnabled\": true,\n \"autoTopupWebhookEnabled\": true\n}"
response = http.request(request)
puts response.read_body{
"lowBalanceEnabled": false,
"lowBalanceEmailEnabled": true,
"lowBalanceWebhookEnabled": true,
"lowBalanceTiers": [
{
"tier": "warning",
"cents": 100000
}
],
"globalHighUsageEnabled": false,
"globalHighUsageEmailEnabled": true,
"globalHighUsageWebhookEnabled": true,
"globalHighUsagePeriodMinutes": 1440,
"globalHighUsageTiers": [
{
"tier": "warning",
"cents": 100000
}
],
"highUsageEnabled": false,
"highUsageEmailEnabled": true,
"highUsageWebhookEnabled": true,
"highUsagePeriodMinutes": 1440,
"highUsageTiers": [
{
"tier": "warning",
"cents": 100000
}
],
"autoTopupNotificationsEnabled": false,
"autoTopupEmailEnabled": true,
"autoTopupWebhookEnabled": true
}Billing Notifications
Upsert billing notification config
PATCH
/
v2
/
billing
/
notifications
/
config
Upsert billing notification config
curl --request PATCH \
--url https://api.topograph.co/v2/billing/notifications/config \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"lowBalanceEnabled": true,
"lowBalanceEmailEnabled": true,
"lowBalanceWebhookEnabled": true,
"lowBalanceTiers": [
{
"tier": "warning",
"cents": 100000
}
],
"globalHighUsageEnabled": false,
"globalHighUsageEmailEnabled": true,
"globalHighUsageWebhookEnabled": true,
"globalHighUsagePeriodMinutes": 1440,
"globalHighUsageTiers": [
{
"tier": "warning",
"cents": 100000
}
],
"highUsageEnabled": false,
"highUsageEmailEnabled": true,
"highUsageWebhookEnabled": true,
"highUsagePeriodMinutes": 1440,
"highUsageTiers": [
{
"tier": "warning",
"cents": 100000
}
],
"autoTopupNotificationsEnabled": false,
"autoTopupEmailEnabled": true,
"autoTopupWebhookEnabled": true
}
'import requests
url = "https://api.topograph.co/v2/billing/notifications/config"
payload = {
"lowBalanceEnabled": True,
"lowBalanceEmailEnabled": True,
"lowBalanceWebhookEnabled": True,
"lowBalanceTiers": [
{
"tier": "warning",
"cents": 100000
}
],
"globalHighUsageEnabled": False,
"globalHighUsageEmailEnabled": True,
"globalHighUsageWebhookEnabled": True,
"globalHighUsagePeriodMinutes": 1440,
"globalHighUsageTiers": [
{
"tier": "warning",
"cents": 100000
}
],
"highUsageEnabled": False,
"highUsageEmailEnabled": True,
"highUsageWebhookEnabled": True,
"highUsagePeriodMinutes": 1440,
"highUsageTiers": [
{
"tier": "warning",
"cents": 100000
}
],
"autoTopupNotificationsEnabled": False,
"autoTopupEmailEnabled": True,
"autoTopupWebhookEnabled": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
lowBalanceEnabled: true,
lowBalanceEmailEnabled: true,
lowBalanceWebhookEnabled: true,
lowBalanceTiers: [{tier: 'warning', cents: 100000}],
globalHighUsageEnabled: false,
globalHighUsageEmailEnabled: true,
globalHighUsageWebhookEnabled: true,
globalHighUsagePeriodMinutes: 1440,
globalHighUsageTiers: [{tier: 'warning', cents: 100000}],
highUsageEnabled: false,
highUsageEmailEnabled: true,
highUsageWebhookEnabled: true,
highUsagePeriodMinutes: 1440,
highUsageTiers: [{tier: 'warning', cents: 100000}],
autoTopupNotificationsEnabled: false,
autoTopupEmailEnabled: true,
autoTopupWebhookEnabled: true
})
};
fetch('https://api.topograph.co/v2/billing/notifications/config', 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/notifications/config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'lowBalanceEnabled' => true,
'lowBalanceEmailEnabled' => true,
'lowBalanceWebhookEnabled' => true,
'lowBalanceTiers' => [
[
'tier' => 'warning',
'cents' => 100000
]
],
'globalHighUsageEnabled' => false,
'globalHighUsageEmailEnabled' => true,
'globalHighUsageWebhookEnabled' => true,
'globalHighUsagePeriodMinutes' => 1440,
'globalHighUsageTiers' => [
[
'tier' => 'warning',
'cents' => 100000
]
],
'highUsageEnabled' => false,
'highUsageEmailEnabled' => true,
'highUsageWebhookEnabled' => true,
'highUsagePeriodMinutes' => 1440,
'highUsageTiers' => [
[
'tier' => 'warning',
'cents' => 100000
]
],
'autoTopupNotificationsEnabled' => false,
'autoTopupEmailEnabled' => true,
'autoTopupWebhookEnabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.topograph.co/v2/billing/notifications/config"
payload := strings.NewReader("{\n \"lowBalanceEnabled\": true,\n \"lowBalanceEmailEnabled\": true,\n \"lowBalanceWebhookEnabled\": true,\n \"lowBalanceTiers\": [\n {\n \"tier\": \"warning\",\n \"cents\": 100000\n }\n ],\n \"globalHighUsageEnabled\": false,\n \"globalHighUsageEmailEnabled\": true,\n \"globalHighUsageWebhookEnabled\": true,\n \"globalHighUsagePeriodMinutes\": 1440,\n \"globalHighUsageTiers\": [\n {\n \"tier\": \"warning\",\n \"cents\": 100000\n }\n ],\n \"highUsageEnabled\": false,\n \"highUsageEmailEnabled\": true,\n \"highUsageWebhookEnabled\": true,\n \"highUsagePeriodMinutes\": 1440,\n \"highUsageTiers\": [\n {\n \"tier\": \"warning\",\n \"cents\": 100000\n }\n ],\n \"autoTopupNotificationsEnabled\": false,\n \"autoTopupEmailEnabled\": true,\n \"autoTopupWebhookEnabled\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.topograph.co/v2/billing/notifications/config")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"lowBalanceEnabled\": true,\n \"lowBalanceEmailEnabled\": true,\n \"lowBalanceWebhookEnabled\": true,\n \"lowBalanceTiers\": [\n {\n \"tier\": \"warning\",\n \"cents\": 100000\n }\n ],\n \"globalHighUsageEnabled\": false,\n \"globalHighUsageEmailEnabled\": true,\n \"globalHighUsageWebhookEnabled\": true,\n \"globalHighUsagePeriodMinutes\": 1440,\n \"globalHighUsageTiers\": [\n {\n \"tier\": \"warning\",\n \"cents\": 100000\n }\n ],\n \"highUsageEnabled\": false,\n \"highUsageEmailEnabled\": true,\n \"highUsageWebhookEnabled\": true,\n \"highUsagePeriodMinutes\": 1440,\n \"highUsageTiers\": [\n {\n \"tier\": \"warning\",\n \"cents\": 100000\n }\n ],\n \"autoTopupNotificationsEnabled\": false,\n \"autoTopupEmailEnabled\": true,\n \"autoTopupWebhookEnabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.topograph.co/v2/billing/notifications/config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"lowBalanceEnabled\": true,\n \"lowBalanceEmailEnabled\": true,\n \"lowBalanceWebhookEnabled\": true,\n \"lowBalanceTiers\": [\n {\n \"tier\": \"warning\",\n \"cents\": 100000\n }\n ],\n \"globalHighUsageEnabled\": false,\n \"globalHighUsageEmailEnabled\": true,\n \"globalHighUsageWebhookEnabled\": true,\n \"globalHighUsagePeriodMinutes\": 1440,\n \"globalHighUsageTiers\": [\n {\n \"tier\": \"warning\",\n \"cents\": 100000\n }\n ],\n \"highUsageEnabled\": false,\n \"highUsageEmailEnabled\": true,\n \"highUsageWebhookEnabled\": true,\n \"highUsagePeriodMinutes\": 1440,\n \"highUsageTiers\": [\n {\n \"tier\": \"warning\",\n \"cents\": 100000\n }\n ],\n \"autoTopupNotificationsEnabled\": false,\n \"autoTopupEmailEnabled\": true,\n \"autoTopupWebhookEnabled\": true\n}"
response = http.request(request)
puts response.read_body{
"lowBalanceEnabled": false,
"lowBalanceEmailEnabled": true,
"lowBalanceWebhookEnabled": true,
"lowBalanceTiers": [
{
"tier": "warning",
"cents": 100000
}
],
"globalHighUsageEnabled": false,
"globalHighUsageEmailEnabled": true,
"globalHighUsageWebhookEnabled": true,
"globalHighUsagePeriodMinutes": 1440,
"globalHighUsageTiers": [
{
"tier": "warning",
"cents": 100000
}
],
"highUsageEnabled": false,
"highUsageEmailEnabled": true,
"highUsageWebhookEnabled": true,
"highUsagePeriodMinutes": 1440,
"highUsageTiers": [
{
"tier": "warning",
"cents": 100000
}
],
"autoTopupNotificationsEnabled": false,
"autoTopupEmailEnabled": true,
"autoTopupWebhookEnabled": true
}Authorizations
Body
application/json
Master toggle for low-balance notifications. Defaults to false on new accounts (strictly opt-in).
Example:
true
Route low-balance notifications via email. Applied when lowBalanceEnabled is true.
Example:
true
Route low-balance notifications via webhook. Applied when lowBalanceEnabled is true.
Example:
true
Ordered list of low-balance tiers. Each tier fires once when the account balance drops at or below its cents threshold. Tier names must be unique.
Required array length:
1 - 10 elementsShow child attributes
Show child attributes
Master toggle for global (account-aggregate) high-usage notifications. Defaults to false on new accounts.
Example:
false
Route global high-usage notifications via email.
Example:
true
Route global high-usage notifications via webhook.
Example:
true
Rolling window, in minutes, used to sum account-aggregate spend when evaluating global high-usage tiers. Min 5 (5 minutes), max 43200 (30 days).
Required range:
5 <= x <= 43200Example:
1440
Global high-usage tiers. Fires when the sum of spend across ALL workspaces (plus the account-wide bucket) over the rolling window meets-or-exceeds cents.
Required array length:
1 - 5 elementsShow child attributes
Show child attributes
Master toggle for per-workspace high-usage notifications. These thresholds are applied individually to each workspace; a workspace can override them via the workspace-override endpoint.
Example:
false
Route per-workspace high-usage notifications via email.
Example:
true
Route per-workspace high-usage notifications via webhook.
Example:
true
Rolling window, in minutes, used to sum per-workspace spend when evaluating high-usage tiers. Min 5, max 43200.
Required range:
5 <= x <= 43200Example:
1440
Per-workspace high-usage tiers. Fires when a single workspace's spend over the rolling window meets-or-exceeds cents.
Required array length:
1 - 5 elementsShow child attributes
Show child attributes
Master toggle for auto-topup outcome notifications (succeeded / failed). Distinct from Account.autoTopupEnabled, which controls the charge itself. Defaults to false on new accounts.
Example:
false
Route auto-topup outcome notifications via email.
Example:
true
Route auto-topup outcome notifications via webhook.
Example:
true
Response
200 - application/json
Master toggle for low-balance notifications.
Example:
false
Route low-balance notifications via email.
Example:
true
Route low-balance notifications via webhook.
Example:
true
Resolved low-balance tiers.
Show child attributes
Show child attributes
Master toggle for global (account-aggregate) high-usage notifications.
Example:
false
Route global high-usage notifications via email.
Example:
true
Route global high-usage notifications via webhook.
Example:
true
Rolling window, in minutes, for global high-usage evaluation.
Example:
1440
Resolved global high-usage tiers.
Show child attributes
Show child attributes
Master toggle for per-workspace high-usage notifications.
Example:
false
Route per-workspace high-usage notifications via email.
Example:
true
Route per-workspace high-usage notifications via webhook.
Example:
true
Rolling window, in minutes, for per-workspace high-usage evaluation.
Example:
1440
Resolved per-workspace high-usage tiers (applied as defaults to every workspace).
Show child attributes
Show child attributes
Master toggle for auto-topup outcome notifications.
Example:
false
Route auto-topup notifications via email.
Example:
true
Route auto-topup notifications via webhook.
Example:
true