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
| Type | Created when |
|---|---|
payment.created | A payment is created. |
payment.updated | A payment changes. |
payment.amount_capturable_updated | A card payment is authorized and is waiting to be captured (requires_capture). |
payment.succeeded | A payment succeeds. |
payment.failed | A payment fails, such as when it’s declined or a bank debit is returned before it succeeded. |
payment.canceled | A payment is canceled. |
refund.created | A refund is created. |
refund.updated | A refund changes. |
refund.succeeded | A refund succeeds. |
refund.failed | A refund fails. |
dispute.created | A dispute is opened, or a succeeded bank debit is returned. |
dispute.updated | A dispute changes, such as when you submit evidence or the bank decides it. |
checkout_session.created | A checkout session is created. |
checkout_session.updated | A checkout session changes. |
checkout_session.completed | A customer completes a checkout session. |
checkout_session.expired | A checkout session expires, or you expire it. |
Customers and payment methods
| Type | Created when |
|---|---|
customer.created | A customer is created. |
customer.updated | A customer changes. |
customer.deleted | A customer is deleted. |
payment_method.created | A payment method is created. |
payment_method.updated | A payment method changes. |
payment_method.deactivated | A payment method is deactivated and can’t be charged again. |
mandate.created | A mandate is recorded for a bank account. |
mandate.updated | A mandate is replaced by a newer one for the same bank account. |
mandate.revoked | A mandate is revoked. |
customer_balance_transaction.created | A customer’s balance changes. |
customer_balance_transaction.updated | A customer balance transaction changes. |
Invoices
| Type | Created when |
|---|---|
invoice.created | An invoice is created. |
invoice.updated | An invoice changes. |
invoice.deleted | A draft invoice is deleted. |
invoice.finalized | A draft invoice is finalized. |
invoice.sent | An invoice is emailed to the customer. |
invoice.reminder_sent | A payment reminder for an invoice is emailed to the customer. |
invoice.paid | An invoice is paid in full, or marked paid. |
invoice.payment_failed | A payment on an invoice fails. |
invoice.voided | An invoice is voided. |
invoice.marked_uncollectible | An invoice is marked uncollectible. |
credit_note.created | A credit note is issued. |
credit_note.updated | A credit note changes. |
credit_note.voided | A credit note is voided. |
Subscriptions
| Type | Created when |
|---|---|
subscription.created | A subscription is created. |
subscription.updated | A subscription changes. |
subscription.trial_will_end | A trial ends in 3 days. |
subscription.will_renew | A subscription is about to renew. |
subscription.past_due | A subscription becomes past_due because a payment failed or a sent invoice is overdue. |
subscription.paused | A subscription is paused. |
subscription.resumed | A paused subscription resumes. |
subscription.canceled | A subscription is canceled. |
Catalog and discounts
| Type | Created when |
|---|---|
product.created | A product is created. |
product.updated | A product changes. |
product.deleted | A product is deleted. |
price.created | A price is created. |
price.updated | A price changes. |
shipping_rate.created | A shipping rate is created. |
shipping_rate.updated | A shipping rate changes. |
discount.created | A discount is created. |
discount.updated | A discount changes. |
discount.deleted | A discount is deleted. |
applied_discount.created | A discount is applied to an invoice, checkout session or line item. |
applied_discount.deleted | A discount code is removed from a checkout session. |
Files
| Type | Created when |
|---|---|
file.created | A file is uploaded. |
file.updated | A file is renamed. |