StripeKit - Type Reference

TypeScript has interfaces for plain data, so StripeKit represents every input and result as a documented interface, the same approach the Stripe SDK itself uses internally. This page lists the shape of every object you will send to, or receive from, StripeKit.

Config (`StripeKit.init()`)

Customers

CreateCustomerInput

KitCustomerRecord, returned by create, retrieve, update, sync

Payment methods

KitPaymentMethodRecord

Payments

CreatePaymentInput

PaymentResult

Checkout

CreateCheckoutInput

CheckoutResult

Subscriptions

CreateSubscriptionInput

KitSubscriptionRecord

Invoices

KitInvoiceRecord

Coupons

CreateCouponInput

KitCouponRecord

Webhooks

kit.webhooks.process() accepts:

Available handler keys: onPaymentSucceeded, onPaymentFailed, onInvoiceCreated, onInvoiceUpdated, onInvoicePaid, onInvoicePaymentFailed, onInvoiceVoided, onInvoiceDeleted, onSubscriptionCreated, onSubscriptionUpdated, onSubscriptionDeleted, onSetupIntentSucceeded, onCheckoutSessionCompleted, onUnhandledEvent. Each handler receives (event: Stripe.Event).

Storage adapter

See Storage adapter and src/types/storage.ts. It is an interface that you implement; only override the methods your application actually uses; everything else safely no-ops.

Type Reference

Config (StripeKit.init())#

Customers#

Payment methods#

Payments#

Checkout#

Subscriptions#

Invoices#

Coupons#

Webhooks#

Storage adapter#