Skip to main content
PATCH
/
v2
/
billing
/
notifications
/
workspaces
/
{workspaceId}
/
config
Upsert workspace high-usage override
curl --request PATCH \
  --url https://api.topograph.co/v2/billing/notifications/workspaces/{workspaceId}/config \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "highUsageEnabled": true,
  "highUsageEmailEnabled": true,
  "highUsageWebhookEnabled": true,
  "highUsagePeriodMinutes": 1440,
  "highUsageTiers": [
    {
      "tier": "warning",
      "cents": 100000
    }
  ]
}
'
{
  "id": "f2b5e0b8-1a3c-4f7e-9d2a-7c6b8a1d4e52",
  "workspaceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "createdAt": "2026-04-15T12:34:56.789Z",
  "updatedAt": "2026-04-22T08:12:34.567Z",
  "highUsageEnabled": true,
  "highUsageEmailEnabled": true,
  "highUsageWebhookEnabled": true,
  "highUsagePeriodMinutes": 720,
  "highUsageTiers": [
    {
      "tier": "warning",
      "cents": 100000
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
workspaceId
string
required

Body

application/json
​
highUsageEnabled
boolean

Override the account-level master toggle for per-workspace high-usage notifications. Undefined means "inherit from account config".

Example:

true

​
highUsageEmailEnabled
boolean

Override the account-level email routing for high-usage notifications for this workspace.

Example:

true

​
highUsageWebhookEnabled
boolean

Override the account-level webhook routing for high-usage notifications for this workspace.

Example:

true

​
highUsagePeriodMinutes
number

Override the rolling window, in minutes, used to sum this workspace's spend when evaluating high-usage tiers. Min 5, max 43200.

Required range: 5 <= x <= 43200
Example:

1440

​
highUsageTiers
object[]

Override the high-usage tiers for this workspace specifically. Fires when the workspace spend over the rolling window meets-or-exceeds cents. Tier names must be unique.

Required array length: 1 - 5 elements

Response

200 - application/json
​
id
string
required

Override row ID.

Example:

"f2b5e0b8-1a3c-4f7e-9d2a-7c6b8a1d4e52"

​
workspaceId
string
required

Workspace ID this override applies to.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
createdAt
string<date-time>
required

Row creation timestamp.

Example:

"2026-04-15T12:34:56.789Z"

​
updatedAt
string<date-time>
required

Row last-update timestamp.

Example:

"2026-04-22T08:12:34.567Z"

​
highUsageEnabled
boolean | null

Override for master high-usage toggle. Null means "inherit".

Example:

true

​
highUsageEmailEnabled
boolean | null

Override for email routing. Null means "inherit".

Example:

true

​
highUsageWebhookEnabled
boolean | null

Override for webhook routing. Null means "inherit".

Example:

true

​
highUsagePeriodMinutes
number | null

Override for rolling window minutes. Null means "inherit".

Example:

720

​
highUsageTiers
object[] | null

Override for tier thresholds. Null means "inherit".