Skip to main content
WEBHOOK
credit_balance.low
{
  "type": "credit_balance.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:
credit_balance.low
​
consumedPercentage
number<double>
required

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

​
thresholdPercentage
number<double>
required

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

​
currencyId
string
required
​
customerId
string
required
​
resourceId
string
required
​
currentBalance
number<double>
required

Effective remaining balance at event time.

​
totalGranted
number<double>
required

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

​
totalConsumed
number<double>
required

Total deducted from the pool at event time.

​
currencyName
string
​
currencyDescription
string
​
currencyUnits
string