WebhookCreditBalance

A customer's organisation-wide credit balance in one credits currency (not the credits seats hold of their own), just after the signal that caused the event, as Get a customer's credit balances shows that pool, with the order and signal involved.

available
Type: number
required

Credits left to use (total less used); below zero once usage passes the balance. Up to 6 decimal places.
creditsCurrencyId
Type: string
required

The credits currency's ID.
currencyKey
Type: string
required

The credits currency's key.
currencyName
Type: string
required

The credits currency's name.
customerId
Type: string
required
externalCustomerId
Type: string | null
required

Your ID for the customer.
orderId
Type: string
required

The order whose prepaid-credits charge spent the credits (ord_…).
periodEnd
Type: string | nullFormat: date-time
required

End of the period, exclusive, from the first of its current grants to expire; null when none of them expires.
periodStart
Type: string | nullFormat: date-time
required

Start of the period the balance covers, from the earliest of its current grants.
signalId
Type: string
required

The signal that caused the event (sig_…).
total
Type: number
required

Credits the customer has this period, from their plan's allowance and grants. Up to 6 decimal places.
used
Type: number
required

Credits used this period. Up to 6 decimal places.

WebhookPaymentFailedData

WebhookCreditsData