Webhook Payloads
Facturation basée sur les crédits
Le payload envoyé à votre point de terminaison webhook lorsqu’un événement de facturation basé sur les crédits se produit — crédits virtuels (appels d’API, jetons, heures de calcul) accordés, consommés, expirés, reportés ou alertes de solde. Ces webhooks ne sont pas liés aux Customer Wallets (soldes monétaires).
Événements webhook de facturation basés sur les crédits
Les événements webhook suivants sont disponibles pour suivre les changements du cycle de vie de la facturation basée sur les crédits. Ces événements s’appliquent aux droits de crédits virtuels (appels d’API, jetons, heures de calcul), pas aux Customer Wallets (soldes monétaires).Événements du grand livre
Tous les événements du grand livre (credit.added à credit.manual_adjustment) partagent la même charge utile CreditLedgerEntryResponse documentée dans le schéma ci-dessous.
La charge utile inclut un champ metadata résolu à partir de la source de l’octroi de crédit — l’abonnement ou le paiement créé lors du passage en caisse. Cela vous permet d’associer vos crédits de portefeuille à votre propre checkout metadata (par exemple, un orgId) plutôt qu’à celui émis par Dodo : les octrois issus de l’abonnement affichent le metadata de l’abonnement et les octrois issus du paiement affichent le metadata du paiement. Le champ est vide lorsque l’octroi n’a pas de source résolvable (par exemple, des crédits accordés directement via l’API).
Événement de Solde Bas (credit.balance_low)
L’événementcredit.balance_low utilise une charge utile différente (CreditBalanceLowPayload) axée sur l’alerte de seuil :
string
Le client dont le solde de crédit a déclenché l’alerte.
string
L’abonnement associé à ce droit de crédit.
string
Le droit de crédit qui a un solde faible.
string
Nom d’affichage du droit de crédit.
string
Solde de crédit actuel au moment de l’alerte.
string
Total des crédits émis par cycle de facturation pour cet abonnement.
integer
Le pourcentage de seuil de solde bas configuré.
string
Le montant absolu de crédit auquel correspond le seuil.
Utilisation de credit.balance_low pour des Alertes Proactives
Utilisez le webhook credit.balance_low pour notifier les clients avant qu’ils n’épuisent leurs crédits :
Get Customer Balance
Vérifiez le solde actuel d’un client via l’API.
Create Ledger Entry
Créditez ou débitez manuellement le solde d’un client.
Schéma de Charge Utile du Webhook
Response for a ledger entry
Brand id this credit ledger entry belongs to
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).
Options disponibles:
credit_added, credit_deducted, credit_expired, credit_rolled_over, rollover_forfeited, overage_charged, overage_reset, auto_top_up, manual_adjustment, refund Dernière modification le 26 juin 2026