Skip to main content
GET
/
v2
/
billing
/
notifications
/
config
Get resolved billing notification config (defaults merged)
curl --request GET \
  --url https://api.topograph.co/v2/billing/notifications/config \
  --header 'x-api-key: <api-key>'
{
  "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

x-api-key
string
header
required

Response

200 - application/json
lowBalanceEnabled
boolean
required

Master toggle for low-balance notifications.

Example:

false

lowBalanceEmailEnabled
boolean
required

Route low-balance notifications via email.

Example:

true

lowBalanceWebhookEnabled
boolean
required

Route low-balance notifications via webhook.

Example:

true

lowBalanceTiers
object[]
required

Resolved low-balance tiers.

globalHighUsageEnabled
boolean
required

Master toggle for global (account-aggregate) high-usage notifications.

Example:

false

globalHighUsageEmailEnabled
boolean
required

Route global high-usage notifications via email.

Example:

true

globalHighUsageWebhookEnabled
boolean
required

Route global high-usage notifications via webhook.

Example:

true

globalHighUsagePeriodMinutes
number
required

Rolling window, in minutes, for global high-usage evaluation.

Example:

1440

globalHighUsageTiers
object[]
required

Resolved global high-usage tiers.

highUsageEnabled
boolean
required

Master toggle for per-workspace high-usage notifications.

Example:

false

highUsageEmailEnabled
boolean
required

Route per-workspace high-usage notifications via email.

Example:

true

highUsageWebhookEnabled
boolean
required

Route per-workspace high-usage notifications via webhook.

Example:

true

highUsagePeriodMinutes
number
required

Rolling window, in minutes, for per-workspace high-usage evaluation.

Example:

1440

highUsageTiers
object[]
required

Resolved per-workspace high-usage tiers (applied as defaults to every workspace).

autoTopupNotificationsEnabled
boolean
required

Master toggle for auto-topup outcome notifications.

Example:

false

autoTopupEmailEnabled
boolean
required

Route auto-topup notifications via email.

Example:

true

autoTopupWebhookEnabled
boolean
required

Route auto-topup notifications via webhook.

Example:

true