# 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

### addon_created

Triggered when an addon is created.

### addon_deleted

Triggered when an addon is deleted.

### addon_updated

Triggered when an addon is changed.

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

### 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_changed

Triggered when a customer is changed.

### customer_created

Triggered when a customer is created.

### customer_deleted

Triggered when a customer is deleted.

### customer_moved_in

Triggered when a customer is copied from another site.

### customer_moved_out

Triggered when a customer is copied to another site.

### dunning_updated

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

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

### mrr_updated

Triggered when either of MRR or CMRR is changed.

### 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_failed

Triggered when the payment collection fails.

### payment_initiated

Triggered when a payment is initiated via direct debit.

### 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_source_added

Triggered when a payment source is added.

### 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 and also when a role is assigned to it.

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

### plan_created

Triggered when a plan is created.

### plan_deleted

Triggered when a plan is deleted.

### plan_updated

Triggered when a plan is changed.

### promotional_credits_added

Triggered when promotional credit is added.

### promotional_credits_deducted

Triggered when promotional credit is deducted.

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

### refund_initiated

Triggered when a refund is initiated via direct debit.

### rule_created

### rule_deleted

### rule_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_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_items_renewed

### subscription_moved_in

### subscription_moved_out

### subscription_movement_failed

### subscription_pause_scheduled

Triggered when the subscription is scheduled to pause.

### subscription_paused

Triggered when the subscription is paused.

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

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

