StripeKit - Events Reference

Every Stripe event type StripeKit recognizes, the handler key you can provide for it, and exactly what StripeKit does automatically before calling your handler (when autoSync is not set to false).

Stripe event type	Handler key	Automatic sync (`autoSync: true`)
`payment_intent.succeeded`	`onPaymentSucceeded`	`kit.payments.sync(paymentIntent.id)`
`payment_intent.payment_failed`	`onPaymentFailed`	`kit.payments.sync(paymentIntent.id)`
`invoice.created`	`onInvoiceCreated`	`kit.invoices.sync(invoice.id)`
`invoice.updated`	`onInvoiceUpdated`	`kit.invoices.sync(invoice.id)`
`invoice.paid`	`onInvoicePaid`	`kit.invoices.sync(invoice.id)`
`invoice.payment_failed`	`onInvoicePaymentFailed`	`kit.invoices.sync(invoice.id)`
`invoice.voided`	`onInvoiceVoided`	`kit.invoices.sync(invoice.id)`
`invoice.deleted`	`onInvoiceDeleted`	`storage.markInvoiceDeleted(invoice.id)`, only if a storage adapter is configured
`customer.subscription.created`	`onSubscriptionCreated`	`kit.subscriptions.sync(subscription.id)`
`customer.subscription.updated`	`onSubscriptionUpdated`	`kit.subscriptions.sync(subscription.id)`
`customer.subscription.deleted`	`onSubscriptionDeleted`	`kit.subscriptions.sync(subscription.id)`
`setup_intent.succeeded`	`onSetupIntentSucceeded`	`kit.paymentMethods.sync(customerId)`, where `customerId` is read off the SetupIntent
`checkout.session.completed`	`onCheckoutSessionCompleted`	None. Nothing is synced automatically for this event, since the checkout session itself isn't a persisted Stripe billing object. Handle this event to call `kit.checkout.markComplete()` yourself, and to fulfil the order.
Any other event type	`onUnhandledEvent`	None.

Notes

If you don't provide a handler for a given key, StripeKit still performs the automatic sync (unless autoSync: false); it just doesn't call anything of yours afterwards. This means your database stays correct even if you only implement the handlers you specifically care about.

onUnhandledEvent is a catch-all for any event type not listed above. Use it for logging or for event types you plan to support later. It is not called for event types that do have a specific handler key, even if you didn't provide that specific handler.

Configure which event types Stripe actually sends to your endpoint from the Stripe Dashboard, or when creating the webhook endpoint via the Stripe API. StripeKit's process() safely ignores any event type it doesn't recognize, routing it to onUnhandledEvent, so it's safe to subscribe to more event types than StripeKit explicitly handles.

Events Reference

Notes#

Notes