Skip to main content
WEBHOOK
credit_balance.depleted
{
  "type": "credit_balance.depleted",
  "currencyId": "tokens",
  "currencyName": "AI Tokens",
  "currencyDescription": "Tokens used for AI features",
  "currencyUnits": "Tokens",
  "customerId": "customer-test-id",
  "resourceId": "resource-1",
  "currentBalance": 0,
  "totalGranted": 1000,
  "totalConsumed": 1000
}

Body

application/json
type
enum<string>
required
Available options:
credit_balance.depleted
currencyId
string
required
customerId
string
required
resourceId
string
required
currentBalance
number<double>
required

Will be 0 at depletion.

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