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 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.