webhooks
Walletdepleted webhook
A wallet’s balance reached zero: its credit is used up
WEBHOOK
Body
application/json
A wallet's balance (credit that pays any charge of any of the customer's subscriptions, net of unbilled usage) reached zero; credit included with a subscription may remain.
Example:
"cus_7n42DGM5Tflk9n8mt7Fhc7"
Example:
"evt_7n42DGM5Tflk9n8mt7Fhc7"
Available options:
metric.created, customer.created, subscription.created, subscription.updated, subscription.cancelled, subscription.ended, invoice.created, invoice.finalized, invoice.paid, invoice.voided, invoice.closed, invoice.consolidated, invoice.deleted, invoice.accounting_pdf_generated, quote.accepted, quote.converted, credit_note.created, credit_note.finalized, credit_note.voided, plan.created, plan.published, plan.archived, product.created, product.updated, product.archived, metric.updated, metric.archived, coupon.created, coupon.updated, coupon.archived, addon.created, addon.updated, addon.archived, refund.issued, refund.settled, refund.failed, payment.reversed, payment.reinstated, payment.failed, wallet.funded, wallet.debited, wallet.balance_low, wallet.credit_unrecovered, wallet.credit_recovered, wallet.auto_top_up_failed, wallet.auto_top_up_suspended, wallet.auto_top_up_consent_changed, wallet.depleted, wallet.recovered, wallet.auto_top_up_cap_reached, credit_grant.expired, entitlement.usage_threshold_reached, entitlement.limit_reached, budget.threshold_reached, budget.exceeded, entitlement.too_many_groups The credit unit (its code) the amounts are in; absent for a currency.
Decimal places of credit_unit: amounts are integers of 10^-precision credit.
Required range:
x >= 0Absent when the amounts are in a credit unit.
Response
200
Webhook received successfully