# Event Types

> For the complete machine-readable documentation index, see [llms.txt](https://apidocs.chargebee.com/llms.txt).


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.

## List of Events

### add_usages_reminder

Triggered on one day before term end of every month.

### alert_status_changed

Triggered when an alert's runtime status for a subscription changes between `IN_ALARM` and `WITHIN_LIMIT`. This indicates a change in the subscription's usage relative to the alert threshold and applies only to usage-based billing.

### applied_business_rules

### attached_item_created

Triggered when an attached item is created.

### attached_item_deleted

Triggered when an attached item is deleted.

### attached_item_updated

Triggered when an attached item is updated.

### authorization_succeeded

Triggered when a authorization transaction is created.

### authorization_voided

Triggered when a authorization transaction is voided. Authorization can be voided either manually or when blocked funds are released by the gateway after a certain period of time.

### business_entity_created

Triggered when a business entity is created

### business_entity_deleted

Triggered when a business entity is deleted

### business_entity_updated

Triggered when a business entity is changed

### business_rule_activated

### business_rule_created

### business_rule_deactivated

### business_rule_deleted

### business_rule_updated

### card_added

Triggered when a card is added for a customer.

### card_deleted

Triggered when a card is deleted for a customer.

### card_expired

Triggered when the card for a customer has expired.

### card_expiry_reminder

Triggered when the customer's credit card is expiring soon. Triggered 30 days before the expiry date.

### card_updated

Triggered when the card is updated for a customer.

### contract_term_cancelled

Triggered when contract term is cancelled.

### contract_term_completed

Triggered when contract term is completed.

### contract_term_created

Triggered when contract term is created.

### contract_term_renewed

Triggered when a contract term is renewed.

### contract_term_terminated

Triggered when contract term is terminated.

### coupon_codes_added

Triggered when coupon codes are added in coupon set.

### coupon_codes_deleted

Triggered when coupon codes are deleted in coupon set.

### coupon_codes_updated

Triggered when coupon codes are updated in coupon set.

### coupon_created

Triggered when a coupon is created.

### coupon_deleted

Triggered when a coupon is deleted.

### coupon_set_created

Triggered when a coupon set is created.

### coupon_set_deleted

Triggered when a coupon set is deleted.

### coupon_set_updated

Triggered when a coupon set is updated.

### coupon_updated

Triggered when a coupon is changed.

### credit_note_created

Triggered when a credit note is created.

### credit_note_created_with_backdating

Triggered when a credit note is created such that generated\_at is a value in the past.

### credit_note_deleted

Triggered when a credit note is deleted.

### credit_note_updated

Triggered when a credit note is updated.

### customer_business_entity_changed

### customer_changed

Triggered when customer details are changed, and the payment method role of a customer is updated.

### customer_created

Triggered when a customer is created.

### customer_deleted

Triggered when a customer is deleted.

### customer_entitlements_updated

Triggered when a `customer_entitlement` is updated.

### customer_moved_in

Triggered when a customer is copied from another site.

### customer_moved_out

Triggered when a customer is copied to another site.

### differential_price_created

Triggered when a differential price is created.

### differential_price_deleted

Triggered when a differential price is deleted.

### differential_price_updated

Triggered when a differential price is updated.

### dunning_updated

### entitlement_overrides_auto_removed

When a limited period `entitlement_override` expires, it is no longer returned. No event is immediately triggered for it. However, after expiry, the `entitlement_override` record gets deleted within 12 hours, triggering the `entitlement_overrides_auto_removed` event. Therefore, this event can be considered a delayed notification for one or more `entitlement_overrides` having expired.

### entitlement_overrides_removed

Triggered when one or more `entitlement_override` objects are removed. This is not triggered when Chargebee removes the objects automatically upon expiry.

### entitlement_overrides_updated

One or more `entitlement_override`s for a subscription were added or updated.

### feature_activated

Triggered when a `feature` status transitions to `active` for the first time.

### feature_archived

Triggered when a `feature` status transitions to `archived`.

### feature_created

Triggered when a `feature` is created.

### feature_deleted

Triggered when a `feature` is deleted.

### feature_reactivated

Triggered when a `feature` status transitions to `active` for the second time or more.

### feature_updated

Triggered when a `feature` is updated. Note: This event is not triggered when only the `status` of the feature has changed.

### gift_cancelled

Triggered when gift is cancelled.

### gift_claimed

Triggered when a gift is claimed.

### gift_expired

Triggered when a gift expires.

### gift_scheduled

Triggered when a new gift is created.

### gift_unclaimed

Triggered when a new gift is unclaimed and is ready to be claimed.

### gift_updated

Triggered when a gift is updated.

### grant_blocks_created

Triggered when one or more [grant blocks](/docs/api/grant_blocks) are created for a subscription unit. The event content includes the created `grant_blocks`.

### grant_blocks_updated

Triggered when one or more [grant blocks](/docs/api/grant_blocks) are updated for a subscription unit. The event content includes the updated `grant_blocks`.

### hierarchy_created

Triggered when a hierarchy is created.

### hierarchy_deleted

Triggered when a hierarchy is deleted.

### invoice_deleted

Event triggered when an invoice is deleted.

### invoice_generated

Event triggered when a new invoice is created except when created with status as pending. For pending invoices, this event is triggered when the invoice is closed.

### invoice_generated_with_backdating

Triggered when an invoice has been created with date set to a value in the past. However, if the invoice is created with a pending status and the site setting is to set invoice.date to the date of closing the invoice, this event is never triggered.

### invoice_updated

Triggered when changes are made to a finalized invoice, including voiding, deletion, invoice address updates, status changes, and payment changes such as applying or removing a payment, applying or removing a credit, and credit note creation. `pending_invoice_updated` is triggered for changes specific to pending invoices; invoice\_updated covers all other invoice changes.

### item_created

Triggered when an item is created.

### item_deleted

Triggered when an item is deleted.

### item_entitlements_removed

One or more `item_entitlement`s were removed for an `item` or a `feature`.

### item_entitlements_updated

One or more `entitlement`s were added or updated for an `item`.

### item_family_created

Triggered when an item family is created.

### item_family_deleted

Triggered when an item family is deleted.

### item_family_updated

Triggered when an item family is updated.

### item_price_created

Triggered when an item price is created.

### item_price_deleted

Triggered when an item price is deleted.

### item_price_entitlements_removed

One or more `item_price_entitlement`s were removed for an `item_price` or a `feature`.

### item_price_entitlements_updated

One or more `entitlement`s were added or updated for an `item_price`.

### item_price_updated

Triggered when an item price is updated.

### item_updated

Triggered when an item is updated.

### ledger_account_balance_updated

Triggered when a [ledger account balance](/docs/api/ledger_account_balances) changes for a subscription unit. The event content includes the updated `ledger_account_balance`.

### ledger_updated

Triggered when a batch of [ledger operations](/docs/api/ledger_operations) is persisted for a subscription unit. The event content includes the related `ledger_operations`, `ledger_account_balance`, `grant_blocks`, and `ledger_entries`.

### mrr_updated

Triggered when either of MRR or CMRR is changed.

### omnichannel_one_time_order_created

### omnichannel_one_time_order_item_cancelled

### omnichannel_subscription_created

Triggered when an omnichannel subscription is created.

### omnichannel_subscription_imported

Triggered when an omnichannel subscription is imported.

### omnichannel_subscription_item_cancellation_scheduled

Triggered when an omnichannel subscription item is scheduled for cancellation.

### omnichannel_subscription_item_cancelled

Triggered when an omnichannel subscription item is cancelled.

### omnichannel_subscription_item_change_scheduled

Triggered when an omnichannel subscription item change is scheduled.

### omnichannel_subscription_item_changed

Triggered when an omnichannel subscription item is changed.

### omnichannel_subscription_item_downgraded

Triggered when an omnichannel subscription item is downgraded.

### omnichannel_subscription_item_dunning_expired

Triggered when an omnichannel subscription item's dunning period has expired.

### omnichannel_subscription_item_dunning_started

Triggered when an omnichannel subscription item has entered a dunning period.

### omnichannel_subscription_item_expired

Triggered when an omnichannel subscription item is expired.

### omnichannel_subscription_item_grace_period_expired

Triggered when an omnichannel subscription item's grace period has expired.

### omnichannel_subscription_item_grace_period_started

Triggered when an omnichannel subscription item has entered a grace period.

### omnichannel_subscription_item_mrr_updated

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`](/docs/api/omnichannel_subscription_item_metrics) snapshot. The event content includes the related [`omnichannel_subscription`](/docs/api/omnichannel_subscriptions), [`omnichannel_subscription_item`](/docs/api/omnichannel_subscription_items), and [`omnichannel_subscription_item_metric`](/docs/api/omnichannel_subscription_item_metrics).

### omnichannel_subscription_item_pause_scheduled

Triggered when an omnichannel subscription item is scheduled for pause.

### omnichannel_subscription_item_paused

Triggered when an omnichannel subscription item is paused.

### omnichannel_subscription_item_reactivated

Triggered when an omnichannel subscription item's refund is reversed.

### omnichannel_subscription_item_recovered

Triggered when an omnichannel subscription item recovers from a billing issue and is active again.

### omnichannel_subscription_item_renewed

Triggered when an omnichannel subscription item is renewed.

### omnichannel_subscription_item_resubscribed

Triggered when an omnichannel subscription item is resubscribed.

### omnichannel_subscription_item_resumed

Triggered when an omnichannel subscription item is resumed.

### omnichannel_subscription_item_scheduled_cancellation_removed

Triggered when an omnichannel subscription item scheduled cancellation is removed.

### omnichannel_subscription_item_scheduled_change_removed

Triggered when an omnichannel subscription item scheduled change is removed.

### omnichannel_subscription_item_updated

Triggered when an omnichannel subscription item is updated.

### omnichannel_subscription_item_upgraded

Triggered when an omnichannel subscription item is upgraded.

### omnichannel_subscription_moved_in

Triggered when an omnichannel subscription is moved to another customer

### omnichannel_transaction_created

Triggered when an omnichannel transaction is created.

### order_cancelled

Triggered when an order is cancelled.

### order_created

Triggered when an order is generated.

### order_deleted

Triggered when an order is deleted.

### order_delivered

Triggered when an order is delivered.

### order_ready_to_process

Triggered when an order reaches it's order date.

### order_ready_to_ship

Triggered when an order reaches it's shipping date.

### order_resent

Triggered when an order is resent.

### order_returned

Triggered when an order is returned.

### order_updated

Triggered when an order is updated.

### payment_due_reminder

### payment_failed

Triggered when the payment collection fails.

### payment_initiated

Triggered when a payment is initiated using the `direct_debit` payment method, or when a transaction enters the `in_progress` status due to asynchronous processing at the payment gateway.

### payment_intent_created

Triggered when a payment intent is created.

### payment_intent_updated

Triggered when a payment intent is updated.

### payment_refunded

Triggered when a payment refund is made.

### payment_schedule_scheme_created

### payment_schedule_scheme_deleted

### payment_schedules_created

### payment_schedules_updated

### payment_source_added

Triggered when a payment source is added.

### payment_source_business_entity_changed

### payment_source_deleted

Triggered when a payment source is deleted.

### payment_source_expired

Triggered when the payment source for a customer has expired.

### payment_source_expiring

Triggered when the customer's payment source is expiring soon. Triggered 30 days before the expiry date.

### payment_source_locally_deleted

Triggered when a payment source is deleted at Chargebee.

### payment_source_updated

Triggered when the payment source is updated.

### payment_succeeded

Triggered when the payment is successfully collected.

### pending_invoice_created

Event triggered (in the case of metered billing) when a "Pending" invoice is created that has usage related charges or line items to be added, before being closed. This is triggered only when the "Notify for Pending Invoices" option is enabled.

### pending_invoice_updated

Triggered when you make the following changes to a pending invoice: add a charge, add a non-recurring addon, or delete a line item.

### price_variant_created

Triggered when a price variant resource is created successfully

### price_variant_deleted

Triggered when a price variant resource is deleted successfully

### price_variant_updated

Triggered when a price variant resource is updated successfully

### promotional_credits_added

Triggered when promotional credit is added.

### promotional_credits_deducted

Triggered when promotional credit is deducted.

### purchase_created

Triggered when a purchase resource is created successfully

### quote_created

Event triggered when a new quote is generated.

### quote_deleted

Event triggered when a new quote is deleted.

### quote_updated

Triggered when a quote is updated.

### record_purchase_failed

Triggered when the record a purchase API fails to create an omnichannel subscription.

### refund_initiated

Triggered when a refund is initiated using the `direct_debit` payment method, or when a transaction enters the `in_progress` status due to asynchronous processing at the payment gateway.

### rule_created

### rule_deleted

### rule_updated

### sales_order_created

### sales_order_updated

### subscription_activated

Triggered after the subscription has been moved from "Trial" to "Active" state.

### subscription_activated_with_backdating

Triggered after the subscription changes to `active` from another `status`, while the change is backdated.

### subscription_advance_invoice_schedule_added

Triggered when advance invoice is scheduled for a subscription.

### subscription_advance_invoice_schedule_removed

Triggered when scheduled advance invoice is removed for a subscription.

### subscription_advance_invoice_schedule_updated

Triggered when scheduled advance invoice is updated for a subscription.

### subscription_business_entity_changed

### subscription_canceled_with_backdating

Triggered when a subscription is canceled with cancel\_at set to a value in the past.

### subscription_cancellation_reminder

Triggered 6 days prior to the scheduled cancellation date.

### subscription_cancellation_scheduled

Triggered when subscription is scheduled to cancel at end of current term.

### subscription_cancelled

Triggered when the subscription is cancelled. If it is cancelled due to non payment or because the card details are not present, the subscription will have the possible reason as 'cancel\_reason'.

### subscription_changed

Triggered when the subscription's recurring items are changed.

### subscription_changed_with_backdating

Triggered when a subscription is changed with changes\_scheduled\_at set to a value in the past.

### subscription_changes_scheduled

Triggered when subscription changes are scheduled for later. Changes will be applied at the end of current term.

### subscription_created

Triggered when a new subscription is created.

### subscription_created_with_backdating

Triggered when a subscription is created and the value of subscription.started\_at is in the past.

### subscription_deleted

Triggered when a subscription is deleted.

### subscription_entitlements_created

Triggered on subscription creation, alongside the subscription\_created event whenever the subscription has subscription\_entitlements. The event payload contains the first 100 subscription\_entitlements. The has\_next attribute is set to true if more than 100 subscription entitlements are available. You can retrieve the next page by calling the "List subscription entitlements" endpoint, passing the offset parameter as 1.

### subscription_entitlements_updated

Triggered on subscription change, alongside the subscription\_changed event whenever there are updates to a subscription's entitlements resulting from modifications to its recurring and non recurring items. The event payload contains the first 100 subscription\_entitlements. The has\_next attribute is set to true if more than 100 subscription entitlements are available. You can retrieve the next page by calling the "List subscription entitlements" endpoint, passing the offset parameter as 1.

### subscription_items_renewed

Triggered when one or more subscription items are renewed.

### subscription_moved_in

Triggered when the subscription is moving in from one customer to another asynchronously.

### subscription_moved_out

Triggered when the subscription is moving out from one customer to another asynchronously.

### subscription_movement_failed

Triggered when the subscription movement fails during moving in or out of a subscription from one customer to another asynchronously.

### subscription_pause_scheduled

Triggered when the subscription is scheduled to pause.

### subscription_paused

Triggered when the subscription is paused.

### subscription_ramp_applied

Triggered when a ramp is executed successfully.

### subscription_ramp_created

Triggered when a ramp is created.

### subscription_ramp_deleted

Triggered when a ramp is deleted.

### subscription_ramp_drafted

Triggered when a ramp is moved to draft status.

### subscription_ramp_updated

Triggered when a ramp is updated.

### subscription_reactivated

Triggered when the subscription is moved from `cancelled` `status` to `active` or `in_trial`.

### subscription_reactivated_with_backdating

Triggered when the subscription is moved from `cancelled` `status` to `active` or `in_trial`, while `reactivate_from` is set to a value in the past.

### subscription_renewal_reminder

Triggered 3 days before each subscription's renewal.

### subscription_renewed

Triggered when the subscription is renewed from the current term.

### subscription_resumed

Triggered when the subscription is resumed.

### subscription_resumption_scheduled

Triggered when the subscription is scheduled to resume.

### subscription_scheduled_cancellation_removed

Triggered when scheduled cancellation is removed for the subscription.

### subscription_scheduled_changes_removed

Triggered when scheduled change for the subscription is removed.

### subscription_scheduled_pause_removed

Triggered when scheduled pause is removed for the subscription.

### subscription_scheduled_resumption_removed

Triggered when scheduled resumption is removed for the subscription.

### subscription_shipping_address_updated

Triggered when shipping address is added or updated for a subscription.

### subscription_started

Triggered when a 'future' subscription gets started.

### subscription_trial_end_reminder

Triggered 6 days prior to the trial period's end date.

### subscription_trial_extended

Trial Extension

### tax_withheld_deleted

Triggered when a tax withheld is deleted.

### tax_withheld_recorded

Triggered when a tax withheld is recorded for an invoice.

### tax_withheld_refunded

Triggered when a tax withheld is refunded.

### token_consumed

Triggered when a nonce is consumed.

### token_created

Triggered when a nonce is created.

### token_expired

Triggered when a nonce is expired.

### transaction_created

Triggered when a transaction is recorded.

### transaction_deleted

Triggered when a transaction is deleted.

### transaction_updated

Triggered when a transaction is updated. E.g. (1) When a transaction is removed, (2) or when an excess payment is applied on an invoice, (3) or when amount\_capturable gets updated.

### unbilled_charges_created

Triggered when unbilled charges are created

### unbilled_charges_deleted

Triggered when unbilled charges are deleted

### unbilled_charges_invoiced

Triggered when unbilled charges are invoiced

### unbilled_charges_voided

Triggered when unbilled charges are voided

### usage_file_ingested

### vault_token_created

### vault_token_deleted

### vault_token_updated

### virtual_bank_account_added

Triggered when a virtual bank account is added.

### virtual_bank_account_deleted

Triggered when a virtual bank account is deleted.

### virtual_bank_account_updated

Triggered when the virtual bank account is updated.

### voucher_create_failed

Triggered when the Payment voucher Creation fails.

### voucher_created

Triggered when a Payment voucher is created.

### voucher_expired

Triggered when a Payment voucher is Expired.

