WEBHOOK
credits.balance.usage_low
{
  "type": "credits.balance.usage_low",
  "consumedPercentage": 92.5,
  "thresholdPercentage": 80,
  "currencyId": "tokens",
  "currencyName": "AI Tokens",
  "currencyDescription": "Tokens used for AI features",
  "currencyUnits": "Tokens",
  "customerId": "customer-test-id",
  "resourceId": "resource-1",
  "currentBalance": 75,
  "totalGranted": 1000,
  "totalConsumed": 925
}

Body

application/json
type
enum<string>
required
Available options:
credits.balance.usage_low
consumedPercentage
number
required

How much of the total granted has been consumed (0–100).

thresholdPercentage
number
required

Threshold that was crossed (e.g., 80).

currencyId
string
required
customerId
string
required
resourceId
string
required
currentBalance
number
required

Effective remaining balance at event time.

totalGranted
number
required

Sum of all grants considered in the pool at event time.

totalConsumed
number
required

Total deducted from the pool at event time.

currencyName
string
currencyDescription
string
currencyUnits
string