Credit grant depleted

Fired when a specific grant’s balance reaches zero. Use to trigger refill workflows or disable features tied to that grant.

WEBHOOK credit_grant.depleted

default

{
  "type": "credit_grant.depleted",
  "amount": 100,
  "consumedAmount": 100,
  "cost": {
    "amount": 50,
    "currency": "USD"
  },
  "currencyId": "tokens",
  "customerId": "customer-test-id",
  "displayName": "Depleted Credits Grant Test",
  "effectiveAt": "2025-09-18T07:37:07.166Z",
  "entityId": "a45f553a-4835-40b5-ab32-f6fbe7c4fa40",
  "expireAt": "2025-09-18T07:37:17.912Z",
  "grantId": "ba63b487-0bf1-43fa-856f-691d77cbef14",
  "grantType": "PAID",
  "priority": 1
}

Body

application/json

type · enum<string> · required

Available options: credit_grant.depleted

customerId · string · required

grantId · string · required

amount · number<double>

consumedAmount · number<double>

cost · object

Show child attributes

currencyId · string

displayName · string

effectiveAt · string<date-time>

entityId · string

expireAt · string<date-time>

grantType · enum<string>

Available options: PAID, PROMO, ADJUSTMENT

priority · integer