Skip to main content

É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énement credit.balance_low utilise une charge utile différente (CreditBalanceLowPayload) axée sur l’alerte de seuil :
string
La marque à laquelle appartient ce crédit.
string
Le client dont le solde de crédits a déclenché l’alerte.
string
L’abonnement associé à ce crédit.
string
Le crédit dont le solde est faible.
string
Nom d’affichage du crédit.
string
Solde de crédits actuel au moment de l’alerte.
string
Total des crédits accordés par cycle de facturation pour cet abonnement.
integer
Pourcentage seuil de solde faible configuré.
string
Montant absolu de crédits auquel correspond le seuil.

Utiliser credit.balance_low pour les alertes proactives

Utilisez le webhook credit.balance_low pour avertir les clients avant qu’ils n’épuisent leurs crédits :
Abonnez-vous à credit.balance_low pour avertir de manière proactive les clients avant qu’ils n’épuisent leurs crédits. Combinez-le avec credit.deducted pour suivre les tendances de consommation en temps réel.

Get Customer Balance

Consultez 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 payload du webhook

Response for a ledger entry

amount
string
requis
balance_after
string
requis
balance_before
string
requis
brand_id
string
requis

Brand id this credit ledger entry belongs to

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

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
requis
overage_before
string
requis
transaction_type
enum<string>
requis
Options 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
Dernière modification le 6 août 2026