Types of Events

This is a list of all the types of events we currently send. We may add more at any time, so in developing and maintaining your code, you should not assume that only these types exist.

All events follow the pattern of

{
    event_dt: integer,
    event_id: string,
    event_type: string,
    object: object
}

where object is the object that was created, updated, deleted, etc.

charge.dispute.closed where object is the dispute object

Occurs when a dispute is closed and the dispute status changes to won or lost.

charge.dispute.created where object is the dispute object

Occurs whenever a customer disputes a charge with their bank (chargeback).

charge.dispute.funds_reinstated where object is the dispute object

Occurs when funds are reinstated to your account after a dispute is closed. This includes partially refunded payments.

charge.dispute.funds_withdrawn where object is the dispute object

Occurs when funds are removed from your account due to a dispute.

charge.dispute.updated where object is the dispute object

Occurs when the dispute is updated (usually with evidence).

charge.refund.updated where object is the refund object

Occurs whenever a refund is updated, on selected payment methods.

charge.refunded where object is the charge object

Occurs whenever a charge is refunded, on selected payment methods.

customer.created where object is the customer object

Occurs whenever a new customer is created.

customer.deleted where object is the customer object

Occurs whenever a customer is deleted.

customer.updated where object is the customer object

Occurs whenever any property of a customer changes.

customer.subscription.created where object is the subscription object

Occurs whenever a customer is signed up for a new plan.

customer.subscription.updated where object is the subscription object

Occurs whenever a subscription changes (e.g., switching from one plan to another, or changing the status from trial to active).

customer.subscription.deleted where object is the subscription object

Occurs whenever a customer's subscription ends.

invoice.created where object is the invoice object

Occurs whenever a new invoice is created.

payment_intent.created where object is the payment intent object

Occurs whenever a new PaymentIntent is created.

payment_intent.succeeded where object is the payment intent object

Occurs whenever a PaymentIntent has succeeded.

refund.created where object is the refund object

Occurs whenever a refund is created, on selected payment methods.

refund.updated where object is the refund object

Occurs whenever a refund is updated, on selected payment methods.