GET /events

The device from which the customer has made the request

The email address of your customer/user. Use this when the email address has only ASCII characters.

The IP address of the customer where the request originated

The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

The number of resources to be returned.

Default value: 10

Returns only the events that occured at/after this time.

Specify it if you need to fetch events of a particular type.

• subscription_cancelling - Sent when the customer's subscription is nearing it's scheduled cancellation date.
• card_deleted - Sent when a card is deleted for a customer
• card_expired - Sent when a card for a customer is expired
• customer_deleted - Sent when a customer is deleted
• subscription_cancelled - Sent when the subscription gets cancelled. If cancelled due to non payment or card not present, the subscription will have the possible reason as 'cancel_reason'.
• subscription_scheduled_cancellation_removed - Sent when scheduled cancellation is removed for the subscription.
• customer_changed - Sent when a customer is changed
• invoice_deleted - Event triggered when an invoice is deleted.
• subscription_shipping_address_updated - Triggered when shipping address is added or updated for a subscription.
• subscription_cancellation_scheduled - Sent when subscription is scheduled to cancel at end of current term
• subscription_created - Sent when a new subscription is created.
• card_expiring - Sent when the customer's credit card is expiring soon. Sent 30 days before the expiry date.
• card_updated - Sent when the card is updated for a customer.
• payment_initiated - Sent when a payment is initiated via direct debit
• subscription_renewed - Sent when the subscription is renewed from the current term.
• subscription_activated - Sent after the subscription has been moved from trial to active state
• subscription_changed - Sent after the subscription's recurring items have been changed
• customer_created - Sent when a customer is created. This event happens when only a new customer is created or when a customer is automatically created during new subscription creation.
• subscription_deleted - Sent when a subscription has been deleted
• subscription_reactivated - Sent when the subscription is moved from cancelled state to active or in_trial state
• subscription_trial_ending - Sent when the customer's trial period is about to end.
• refund_initiated - Sent when a refund is initiated via direct debit
• transaction_deleted - Triggered when a transaction is deleted.
• subscription_trial_extended - Trial Extension
• 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.
• card_added - Sent when a card is added for a customer.
• subscription_renewal_reminder - Sent before each subscription's renewal based on plan's period
• invoice_updated - Triggered when the invoice’s shipping/billing address is updated, if the invoice is voided, or when the amount due is modified due to payments applied/removed.
• payment_refunded - Sent when a payment refund is made
• payment_succeeded - Sent when the payment is successfully collected
• payment_failed - Sent when attempt to charge customer's credit card fails
• subscription_started - Sent when a 'future' subscription gets started at the scheduled date.
• invoice_generated - Event triggered when a new invoice is generated. In case of metered billing, this event is triggered when a "Pending" invoice is closed.
• 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.
• transaction_created - Triggered when a transaction is recorded

Possible values:

• "subscription_created"
• "subscription_scheduled_cancellation_removed"
• "invoice_generated"
• "refund_initiated"
• "card_updated"
• "subscription_trial_ending"
• "subscription_cancelled"
• "invoice_created"
• "invoice_updated"
• "transaction_updated"
• "customer_created"
• "transaction_created"
• "payment_succeeded"
• "subscription_trial_extended"
• "subscription_cancellation_scheduled"
• "card_expiring"
• "payment_initiated"
• "transaction_deleted"
• "payment_refunded"
• "invoice_deleted"
• "payment_failed"
• "customer_deleted"
• "subscription_shipping_address_updated"
• "card_deleted"
• "card_expired"
• "subscription_renewal_reminder"
• "subscription_activated"
• "subscription_started"
• "subscription_changed"
• "subscription_renewed"
• "subscription_deleted"
• "subscription_reactivated"
• "card_added"
• "customer_changed"
• "subscription_cancelling"

Returns the events (occurred in the past 6 days) which has this status in any of the events' webhooks.
Note : To retrieve events which have occurred before the 6 day period, use the occurred_at(start_time/end_time) attribute.

• not_applicable - Webhook call is not applicable for this event.
• re_scheduled - Webhook call has been rescheduled due failure(s) in previous call(s)
• succeeded - Webhook call was successful.
• not_configured - Webhook was not configured when this event occurred
• scheduled - Webhook call has been scheduled.
• failed - Webhook call has been suspended after the all retries have resulted in failure.
• skipped - Skipped as specified in request

Possible values:

• "failed"
• "skipped"
• "re_scheduled"
• "disabled"
• "succeeded"
• "not_configured"
• "scheduled"
• "not_applicable"

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset to the value of next_offset obtained in the previous iteration of the API call.

Returns only the events that occured at/before this time.