Skip to main content
WEBHOOK

Body

application/json
type
enum<string>
required
Available options:
credit_balance.depleted
messageId
string
required

Unique webhook message ID for idempotency.

timestamp
string<date-time>
required

Time the event was generated.

customer
object
required

Customer whose credit balance was depleted.

creditCurrency
object
required

Credit currency (type) that was depleted.

totalGranted
number<double>
required

Sum of all grants in the pool at event time.

remainingBalance
number<double>
required

Remaining balance at event time (will be 0 at depletion).

traceId
string

Correlation ID for tracing.

eventId
string

Unique ID of the underlying event that triggered this webhook.

consumedPercentage
number<double>

How much of the total granted has been consumed (will be 100 at depletion).