Sign in
Webhook Events

wallet.ongoing_balance.updated

Fired when a wallet's ongoing (real-time) balance changes. Doc-only for parsing.

post/webhook-events/wallet.ongoing_balance.updated

Response

Webhook payload

event_type'subscription.created' | 'subscription.draft.created' | 'subscription.activated' | 'subscription.updated' | 'subscription.paused' | 'subscription.cancelled' | 'subscription.resumed' | 'subscription.plan_changed' | 'subscription.phase.created' | 'subscription.phase.updated' | 'subscription.phase.deleted' | 'feature.created' | 'feature.updated' | 'feature.deleted' | 'feature.wallet_balance.alert' | 'entitlement.created' | 'entitlement.updated' | 'entitlement.deleted' | 'wallet.created' | 'wallet.updated' | 'wallet.terminated' | 'wallet.transaction.created' | 'wallet.transaction.updated' | 'payment.created' | 'payment.updated' | 'payment.failed' | 'payment.success' | 'payment.pending' | 'customer.created' | 'customer.updated' | 'customer.deleted' | 'invoice.update.finalized' | 'invoice.update.payment' | 'invoice.update.voided' | 'invoice.update' | 'invoice.payment.overdue' | 'wallet.credit_balance.dropped' | 'wallet.credit_balance.recovered' | 'wallet.ongoing_balance.dropped' | 'wallet.ongoing_balance.recovered' | 'wallet.ongoing_balance.updated' | 'subscription.spend.threshold_reached' | 'subscription.spend.threshold_recovered' | 'subscription.line_item_spend.threshold_reached' | 'subscription.line_item_spend.threshold_recovered' | 'subscription.group_spend.threshold_reached' | 'subscription.group_spend.threshold_recovered' | 'entitlement.grant.exhausted' | 'subscription.renewal.due' | 'invoice.communication.triggered' | 'credit_note.created' | 'credit_note.updated' | 'checkout.session.initiated' | 'checkout.session.completed' | 'checkout.session.failed' | 'checkout.session.expired' | 'event.rejected'

Changes

Changed in 3 of the 108 revisions of this API.202

  • 29f14678f58f19See the full diff
    • ●

      removed the optional property customer from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property wallet/alert_settings from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property wallet/alert_state from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property wallet/auto_topup from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property wallet/config from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property wallet/created_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property wallet/created_by from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property wallet/credits_available_breakdown from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property wallet/description from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property wallet/environment_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property wallet/metadata from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property wallet/real_time_balance from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property wallet/real_time_credit_balance from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property wallet/status from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property wallet/tenant_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property wallet/topup_conversion_rate from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property wallet/updated_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property wallet/updated_by from the response with the 200 status

      response-optional-property-removed

    • ●

      added the new subscription.plan_changed enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 50b7421a969011See the full diff
    • ●

      added the new entitlement.grant.exhausted enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property wallet/auto_topup/cooldown to the response with the 200 status

      response-optional-property-added

  • f8ecf435d25d1See the full diff
    • ○

      endpoint added

      endpoint-added