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
La marca a la que pertenece este crédito.
string
El cliente cuyo saldo de créditos activó la alerta.
string
La suscripción asociada a este crédito.
string
El crédito que tiene un saldo bajo.
string
Nombre visible del crédito.
string
Saldo de créditos actual en el momento de la alerta.
string
Total de créditos emitidos por ciclo de facturación para esta suscripción.
integer
Porcentaje del umbral de saldo bajo configurado.
string
Cantidad absoluta de créditos a la que corresponde el umbral.

Usar credit.balance_low para alertas proactivas

Usa 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. Combínalo con credit.deducted para realizar un seguimiento de los patrones de consumo en tiempo real.

Get Customer Balance

Consulta el saldo actual de un cliente mediante la API.

Create Ledger Entry

Añade o descuenta créditos manualmente del saldo de un cliente.

Esquema del payload 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 6 de agosto de 2026