TOtopograph
Billing Notifications

Get resolved billing notification config (defaults merged)

get/v2/billing/notifications/config

Request

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

Response

lowBalanceEnabledboolean required

Master toggle for low-balance notifications.

lowBalanceEmailEnabledboolean required

Route low-balance notifications via email.

lowBalanceWebhookEnabledboolean required

Route low-balance notifications via webhook.

globalHighUsageEnabledboolean required

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

globalHighUsageEmailEnabledboolean required

Route global high-usage notifications via email.

globalHighUsageWebhookEnabledboolean required

Route global high-usage notifications via webhook.

globalHighUsagePeriodMinutesnumber required

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

highUsageEnabledboolean required

Master toggle for per-workspace high-usage notifications.

highUsageEmailEnabledboolean required

Route per-workspace high-usage notifications via email.

highUsageWebhookEnabledboolean required

Route per-workspace high-usage notifications via webhook.

highUsagePeriodMinutesnumber required

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

autoTopupNotificationsEnabledboolean required

Master toggle for auto-topup outcome notifications.

autoTopupEmailEnabledboolean required

Route auto-topup notifications via email.

autoTopupWebhookEnabledboolean required

Route auto-topup notifications via webhook.

Example response

{
  "lowBalanceEmailEnabled": true,
  "lowBalanceWebhookEnabled": true,
  "lowBalanceTiers": [
    {
      "tier": "warning",
      "cents": 100000
    }
  ],
  "globalHighUsageEmailEnabled": true,
  "globalHighUsageWebhookEnabled": true,
  "globalHighUsagePeriodMinutes": 1440,
  "globalHighUsageTiers": [
    {
      "tier": "warning",
      "cents": 100000
    }
  ],
  "highUsageEmailEnabled": true,
  "highUsageWebhookEnabled": true,
  "highUsagePeriodMinutes": 1440,
  "highUsageTiers": [
    {
      "tier": "warning",
      "cents": 100000
    }
  ],
  "autoTopupEmailEnabled": true,
  "autoTopupWebhookEnabled": true
}

Changes

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