Skip to main content

Eventos de Webhook de Facturación Basada en Créditos

Los siguientes eventos de webhook están disponibles para rastrear los cambios en el ciclo de vida de la facturación basada en créditos. Estos eventos se aplican a los derechos de crédito virtuales (llamadas a la API, tokens, horas de cómputo), no a las Billeteras de Cliente (saldos monetarios).

Eventos del Libro Mayor

Todos los eventos del libro mayor (credit.added hasta credit.manual_adjustment) comparten la misma carga útil CreditLedgerEntryResponse documentada en el esquema a continuación. La carga útil incluye un campo metadata resuelto desde la fuente del otorgamiento de crédito: la suscripción o el pago creado en el checkout. Esto te permite asociar créditos de billetera basados en tu propio checkout metadata (por ejemplo, un orgId) en lugar del emitido por Dodo customer_id: los otorgamientos basados en suscripción muestran el metadata de la suscripción y los basados en pago muestran el metadata del pago. El campo está vacío cuando el otorgamiento no tiene una fuente resoluble (por ejemplo, créditos otorgados directamente a través de la API).

Evento de Bajo Saldo (credit.balance_low)

El evento credit.balance_low utiliza una carga útil diferente (CreditBalanceLowPayload) enfocada en alertas de umbral:
string
El cliente cuyo saldo de crédito activó la alerta.
string
La suscripción asociada con este derecho de crédito.
string
El derecho de crédito que tiene un saldo bajo.
string
Nombre para mostrar del derecho de crédito.
string
Saldo de crédito actual en el momento de la alerta.
string
Total de créditos emitidos por ciclo de facturación para esta suscripción.
integer
El porcentaje de umbral de bajo saldo configurado.
string
La cantidad de crédito absoluta que corresponde al umbral.

Usando credit.balance_low para Alertas Proactivas

Utiliza el webhook credit.balance_low para notificar a los clientes antes de que se queden sin créditos:
Suscríbete a credit.balance_low para alertar proactivamente a los clientes antes de que agoten sus créditos. Combina con credit.deducted para rastrear patrones de consumo en tiempo real.

Get Customer Balance

Verifica el saldo actual de un cliente a través de la API.

Create Ledger Entry

Acredita o debita manualmente el saldo de un cliente.

Esquema de Carga Útil del Webhook

Response for a ledger entry

amount
string
requerido
balance_after
string
requerido
balance_before
string
requerido
brand_id
string
requerido

Brand id this credit ledger entry belongs to

business_id
string
requerido
created_at
string<date-time>
requerido
credit_entitlement_id
string
requerido
customer_id
string
requerido
id
string
requerido
is_credit
boolean
requerido
metadata
Metadata · object
requerido

Metadata associated with the credit grant's source (the subscription or payment created at checkout). Empty when the grant has no resolvable source (e.g. credits granted directly via the API).

overage_after
string
requerido
overage_before
string
requerido
transaction_type
enum<string>
requerido
Opciones disponibles:
credit_added,
credit_deducted,
credit_expired,
credit_rolled_over,
rollover_forfeited,
overage_charged,
overage_reset,
auto_top_up,
manual_adjustment,
refund
description
string | null
grant_id
string | null
reference_id
string | null
reference_type
string | null
Última modificación el 26 de junio de 2026