Webhook Payloads
Webhooks för kreditbaserad fakturering
Nyttolasten som skickas till din webhook-endpoint när händelser för kreditbaserad fakturering inträffar — virtuella krediter tilldelas, förbrukas, förfaller eller överförs, eller när saldoaviseringar utlöses.
Webhook-händelser för kreditbaserad fakturering
Följande webhook-händelser finns tillgängliga för att spåra förändringar i livscykeln för kreditbaserad fakturering. Dessa händelser gäller virtuella krediträttigheter (API-anrop, tokens, beräkningstimmar), inte Customer Wallets (monetära saldon).Bokföringshändelser
Alla bokföringshändelser (credit.added genom credit.manual_adjustment) delar samma CreditLedgerEntryResponse-payload som dokumenteras i schemat nedan.
Payloaden inkluderar ett metadata-fält som hämtas från källan för kreditgivningen — abonnemanget eller betalningen som skapades vid checkout. Detta låter dig använda plånbokskrediter baserat på din egen checkout metadata (till exempel, en orgId) istället för det av Dodo utfärdade customer_id: kreditgivningar från abonnemang visar abonnemangets metadata och kreditgivningar från betalning visar betalningens metadata. Fältet är tomt när kreditgivningen inte har någon lösbar källa (till exempel, krediter som ges direkt via API:et).
Lågbalansevenemang (credit.balance_low)
Evenemangetcredit.balance_low använder en annan payload (CreditBalanceLowPayload) fokuserad på tröskelvarningar:
string
Varumärket som denna kredittilldelning tillhör.
string
Kunden vars kreditsaldo utlöste aviseringen.
string
Prenumerationen som är kopplad till denna kredittilldelning.
string
Kredittilldelningen som har ett lågt saldo.
string
Visningsnamnet för kredittilldelningen.
string
Aktuellt kreditsaldo vid tidpunkten för aviseringen.
string
Totalt antal krediter som utfärdas per faktureringscykel för denna prenumeration.
integer
Den konfigurerade procentuella tröskeln för lågt saldo.
string
Det absoluta kreditbelopp som tröskeln motsvarar.
Använda credit.balance_low för proaktiva aviseringar
Använd webhooken credit.balance_low för att meddela kunder innan deras krediter tar slut:
Get Customer Balance
Kontrollera en kunds aktuella saldo via API.
Create Ledger Entry
Kreditera eller debitera manuellt en kunds saldo.
Webhook-schema
Response for a ledger entry
Brand id this credit ledger entry belongs to
Metadata associated with this entry.
Tillgängliga alternativ:
credit_added, credit_deducted, credit_expired, credit_rolled_over, rollover_forfeited, overage_charged, overage_reset, auto_top_up, manual_adjustment, refund Senast ändrad 26 september 2026