Event types

An event’s type names the object and what happened to it, as object.action. Listing and streaming events accept filters: { type: "payment.succeeded" } to return one type.

A change with its own type, such as a payment succeeding, creates that event and no *.updated event.

Payments

TypeCreated when
payment.createdA payment is created.
payment.updatedA payment changes.
payment.amount_capturable_updatedA card payment is authorized and is waiting to be captured (requires_capture).
payment.succeededA payment succeeds.
payment.failedA payment fails, such as when it’s declined or a bank debit is returned before it succeeded.
payment.canceledA payment is canceled.
refund.createdA refund is created.
refund.updatedA refund changes.
refund.succeededA refund succeeds.
refund.failedA refund fails.
dispute.createdA dispute is opened, or a succeeded bank debit is returned.
dispute.updatedA dispute changes, such as when you submit evidence or the bank decides it.
checkout_session.createdA checkout session is created.
checkout_session.updatedA checkout session changes.
checkout_session.completedA customer completes a checkout session.
checkout_session.expiredA checkout session expires, or you expire it.

Customers and payment methods

TypeCreated when
customer.createdA customer is created.
customer.updatedA customer changes.
customer.deletedA customer is deleted.
payment_method.createdA payment method is created.
payment_method.updatedA payment method changes.
payment_method.deactivatedA payment method is deactivated and can’t be charged again.
mandate.createdA mandate is recorded for a bank account.
mandate.updatedA mandate is replaced by a newer one for the same bank account.
mandate.revokedA mandate is revoked.
customer_balance_transaction.createdA customer’s balance changes.
customer_balance_transaction.updatedA customer balance transaction changes.

Invoices

TypeCreated when
invoice.createdAn invoice is created.
invoice.updatedAn invoice changes.
invoice.deletedA draft invoice is deleted.
invoice.finalizedA draft invoice is finalized.
invoice.sentAn invoice is emailed to the customer.
invoice.reminder_sentA payment reminder for an invoice is emailed to the customer.
invoice.paidAn invoice is paid in full, or marked paid.
invoice.payment_failedA payment on an invoice fails.
invoice.voidedAn invoice is voided.
invoice.marked_uncollectibleAn invoice is marked uncollectible.
credit_note.createdA credit note is issued.
credit_note.updatedA credit note changes.
credit_note.voidedA credit note is voided.

Subscriptions

TypeCreated when
subscription.createdA subscription is created.
subscription.updatedA subscription changes.
subscription.trial_will_endA trial ends in 3 days.
subscription.will_renewA subscription is about to renew.
subscription.past_dueA subscription becomes past_due because a payment failed or a sent invoice is overdue.
subscription.pausedA subscription is paused.
subscription.resumedA paused subscription resumes.
subscription.canceledA subscription is canceled.

Catalog and discounts

TypeCreated when
product.createdA product is created.
product.updatedA product changes.
product.deletedA product is deleted.
price.createdA price is created.
price.updatedA price changes.
shipping_rate.createdA shipping rate is created.
shipping_rate.updatedA shipping rate changes.
discount.createdA discount is created.
discount.updatedA discount changes.
discount.deletedA discount is deleted.
applied_discount.createdA discount is applied to an invoice, checkout session or line item.
applied_discount.deletedA discount code is removed from a checkout session.

Files

TypeCreated when
file.createdA file is uploaded.
file.updatedA file is renamed.