Skip to main content
WEBHOOK
credit_grant.balance.low
{
  "type": "credit_grant.balance.low",
  "amount": 100,
  "consumedAmount": 85,
  "consumedPercentage": 85,
  "cost": {
    "amount": 5,
    "currency": "USD"
  },
  "currencyId": "tokens",
  "customerId": "customer-test-id",
  "displayName": "Usage Low Credits Grant Test",
  "effectiveAt": "2025-09-18T07:37:08.091Z",
  "entityId": "9cb9dcb3-7848-4d34-82f8-896281938ac4",
  "expireAt": "2025-09-18T07:37:11.898Z",
  "grantId": "7c33e7b0-9743-4b2d-9a8c-3905bbd73646",
  "grantType": "PAID",
  "priority": 1,
  "thresholdPercentage": 80
}

Body

application/json
​
type
enum<string>
required
Available options:
credit_grant.balance.low
​
customerId
string
required
​
grantId
string
required
​
thresholdPercentage
number<double>
required
​
amount
number<double>
​
consumedAmount
number<double>
​
consumedPercentage
number<double>
​
cost
object
​
currencyId
string
​
displayName
string
​
effectiveAt
string<date-time>
​
entityId
string
​
expireAt
string<date-time>
​
grantType
enum<string>
Available options:
PAID,
PROMO,
ADJUSTMENT
​
priority
integer