Skip to main content
WEBHOOK
credits.granted
{
  "type": "credits.granted",
  "amount": 100,
  "consumedAmount": 0,
  "cost": {
    "amount": 50,
    "currency": "USD"
  },
  "currencyId": "USD",
  "customerId": "customer-test-id",
  "displayName": "Credits Grant Test",
  "effectiveAt": "2025-09-18T07:37:08.782Z",
  "entityId": "6daefa44-3667-4547-99a7-090208827332",
  "expireAt": "2025-09-18T07:37:17.607Z",
  "grantId": "1b91bd1e-f275-41a2-8d5a-aa76c9151e0e",
  "grantType": "PAID",
  "priority": 1
}

Body

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