Event Types
This is a list of the event types we currently support. We will continue to add more events moving forward. All events follow a uniform pattern - <resource>_<event_name>. The resources that will be present in the event content are provided beneath each event type's description.
Note: If consolidated invoicing is enabled, the attributes invoice.subscription_id and credit_note.subscription_id should not be used (as it will not be present if the invoice / credit note has lines from multiple subscriptions). Instead to know the related subscriptions, their line_items' subscription_id attribute should be referred.
Triggered when a chargeback is raised against a payment, that is, when Chargebee first records a dispute whose type is chargeback. Disputes of type inquiry don't trigger this event.
If the gateway reports the chargeback as already won or lost when Chargebee first records it, only chargeback_won or chargeback_lost is triggered. Later changes to the dispute status, other than to won or lost, don't trigger an event.
The event content includes the related dispute, transaction, and customer, and the subscription if the disputed payment belongs to one.
Triggered when a chargeback is resolved in the cardholder's favor, that is, when the status of a dispute whose type is chargeback changes to lost.
This can be the first event for a dispute if the gateway reports the chargeback as already lost when Chargebee first records it; chargeback_initiated isn't triggered in that case.
The event content includes the related dispute, transaction, and customer, and the subscription if the disputed payment belongs to one.
Triggered when a chargeback is resolved in the merchant's favor, that is, when the status of a dispute whose type is chargeback changes to won.
This can be the first event for a dispute if the gateway reports the chargeback as already won when Chargebee first records it; chargeback_initiated isn't triggered in that case.
The event content includes the related dispute, transaction, and customer, and the subscription if the disputed payment belongs to one.
Triggered when a collections payment promise is marked as broken.
The event content includes collections_payment_promise.
Triggered when a collections payment promise is cancelled.
The event content includes collections_payment_promise.
Triggered when a collections payment promise is created.
The event content includes collections_payment_promise.
Triggered when a collections payment promise is fulfilled.
The event content includes collections_payment_promise.
Triggered when a collections payment promise is updated.
The event content includes collections_payment_promise.
Triggered when one or more grant blocks are created for a subscription unit.
The event content includes the created grant_blocks.
Triggered when one or more grant blocks are updated for a subscription unit.
The event content includes the updated grant_blocks.
Triggered when a ledger account balance changes for a subscription unit.
The event content includes the updated ledger_account_balance.
Triggered when a batch of ledger operations is persisted for a subscription unit.
The event content includes the related ledger_operations, ledger_account_balance, grant_blocks, and ledger_entries.
Triggered when an omnichannel subscription item is cancelled.
Triggered when the MRR (Monthly Recurring Revenue) computed for an omnichannel subscription item changes, for example due to a renewal, a price or offer change, or a status transition that affects revenue.
Each occurrence delivers a new immutable omnichannel_subscription_item_metric snapshot.
The event content includes the related omnichannel_subscription, omnichannel_subscription_item, and omnichannel_subscription_item_metric.