Webhook Events

feature.wallet_balance.alert

Fired when a feature's associated wallet balance crosses an alert threshold. Doc-only for parsing.

post/webhook-events/feature.wallet_balance.alert

Response

Webhook payload

alert_status'ok' | 'info' | 'warning' | 'in_alarm'
alert_type'low_ongoing_balance' | 'low_credit_balance' | 'feature_wallet_balance' | 'subscription_spend' | 'subscription_line_item_spend' | 'subscription_group_spend' | 'entitlement_grant_threshold' | 'entitlement_grant_exhausted'
credit_balancestring
current_balancestring
customer_idstring
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'
feature_idstring
wallet_idstring

Changes

Changed in 11 of the 108 revisions of this API.28219

  • 29f14678f58f45See the full diff
    • removed the optional property customer from the response with the 200 status

      response-optional-property-removed

    • removed the optional property feature from the response with the 200 status

      response-optional-property-removed

    • removed the optional property wallet 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

    • added the optional property credit_balance to the response with the 200 status

      response-optional-property-added

    • added the optional property current_balance to the response with the 200 status

      response-optional-property-added

    • added the optional property customer_id to the response with the 200 status

      response-optional-property-added

    • added the optional property feature_id to the response with the 200 status

      response-optional-property-added

    • added the optional property wallet_id to the response with the 200 status

      response-optional-property-added

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

  • 50b7421a969031See 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 new entitlement_grant_exhausted enum value to the alert_type response property for the response status 200

      response-property-enum-value-added

    • added the new entitlement_grant_threshold enum value to the alert_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

  • f8ecf435d25d203See the full diff
    • added the new event.rejected enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new feature_wallet_balance enum value to the alert_type response property for the response status 200

      response-property-enum-value-added

    • added the new in_alarm enum value to the alert_status response property for the response status 200

      response-property-enum-value-added

    • added the new info enum value to the alert_status response property for the response status 200

      response-property-enum-value-added

    • added the new invoice_line_item enum value to the customer/integrations/items/entity_type response property for the response status 200

      response-property-enum-value-added

    • added the new low_credit_balance enum value to the alert_type response property for the response status 200

      response-property-enum-value-added

    • added the new low_ongoing_balance enum value to the alert_type response property for the response status 200

      response-property-enum-value-added

    • added the new ok enum value to the alert_status response property for the response status 200

      response-property-enum-value-added

    • added the new subscription.group_spend.threshold_reached enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new subscription.group_spend.threshold_recovered enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new subscription.line_item_spend.threshold_reached enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new subscription.line_item_spend.threshold_recovered enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new subscription.spend.threshold_reached enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new subscription.spend.threshold_recovered enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new subscription_group_spend enum value to the alert_type response property for the response status 200

      response-property-enum-value-added

    • added the new subscription_line_item_spend enum value to the alert_type response property for the response status 200

      response-property-enum-value-added

    • added the new subscription_spend enum value to the alert_type response property for the response status 200

      response-property-enum-value-added

    • added the new wallet.ongoing_balance.updated enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new wallet.transaction.updated enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new warning enum value to the alert_status response property for the response status 200

      response-property-enum-value-added

    • added the optional property customer/contact to the response with the 200 status

      response-optional-property-added

    • added the optional property wallet/real_time_balance to the response with the 200 status

      response-optional-property-added

    • added the optional property wallet/real_time_credit_balance to the response with the 200 status

      response-optional-property-added

    • the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • added the optional property alert_status to the response with the 200 status

      response-optional-property-added

    • added the optional property alert_type to the response with the 200 status

      response-optional-property-added

    • added the optional property customer to the response with the 200 status

      response-optional-property-added

    • added the optional property event_type to the response with the 200 status

      response-optional-property-added

    • added the optional property feature to the response with the 200 status

      response-optional-property-added

    • added the optional property wallet to the response with the 200 status

      response-optional-property-added

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

    • the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • removed the optional property alert_status from the response with the 200 status

      response-optional-property-removed

    • removed the optional property alert_type from the response with the 200 status

      response-optional-property-removed

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

      response-optional-property-removed

    • removed the optional property event_type from the response with the 200 status

      response-optional-property-removed

    • removed the optional property feature from the response with the 200 status

      response-optional-property-removed

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

      response-optional-property-removed

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

  • 7857ddc6e44d21See the full diff
    • added the new checkout.session.expired enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new config enum value to the feature/type response property for the response status 200

      response-property-enum-value-added

    • added the optional property customer/timezone to the response with the 200 status

      response-optional-property-added

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

    • added the new checkout.session.completed enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new checkout.session.failed enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new checkout.session.initiated enum value to the event_type response property for the response status 200

      response-property-enum-value-added

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

    • added the optional property customer/integrations/items/metadata to the response with the 200 status

      response-optional-property-added

    • removed the optional property customer/parent_customer from the response with the 200 status

      response-optional-property-removed

    • removed the optional property customer/parent_customer_id from the response with the 200 status

      response-optional-property-removed

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

  • 3d452eb9ebcc421See the full diff
    • added the new credit_note.created enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new credit_note.updated enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new customer.created enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new customer.deleted enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new customer.updated enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new entitlement.created enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new entitlement.deleted enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new entitlement.updated enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new feature.created enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new feature.deleted enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new feature.updated enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new feature.wallet_balance.alert enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new invoice.communication.triggered enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new invoice.payment.overdue enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new invoice.update enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new invoice.update.finalized enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new invoice.update.payment enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new invoice.update.voided enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new payment.created enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new payment.failed enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new payment.pending enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new payment.success enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new payment.updated enum value to the event_type response property for the response status 200

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

    • added the new subscription.draft.created enum value to the event_type response property for the response status 200

      response-property-enum-value-added

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

      response-property-enum-value-added

    • added the new subscription.phase.created enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new subscription.phase.deleted enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new subscription.phase.updated enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new subscription.renewal.due enum value to the event_type response property for the response status 200

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

    • added the new wallet.created enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new wallet.credit_balance.dropped enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new wallet.credit_balance.recovered enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new wallet.ongoing_balance.dropped enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new wallet.ongoing_balance.recovered enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new wallet.terminated enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new wallet.transaction.created enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new wallet.updated enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the optional property customer/integrations to the response with the 200 status

      response-optional-property-added

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