API Reference

Complete API documentation for Vue Stripe components and composables.

Components

Provider Components

• StripeProvider - Root component that loads Stripe.js
• StripeElements - Creates Stripe Elements instance

Element Components

• StripePaymentElement - All-in-one payment UI (recommended)
• StripeExpressCheckoutElement - Apple Pay, Google Pay, Link
• StripeCardElement - Single card input
• Split Card Elements - Number + Expiry + CVC
• StripeAddressElement - Address collection
• StripeLinkAuthenticationElement - Link authentication

Checkout

• StripeCheckout - Embedded Stripe Checkout

Composables

• useStripe - Access Stripe instance
• useStripeElements - Access Elements instance
• usePaymentIntent - Payment confirmation helpers
• useSetupIntent - SetupIntent confirmation helpers
• useStripeCheckout - Redirect to Stripe Checkout

Plugin

• createVueStripe - Vue plugin for global Stripe configuration

Types

All TypeScript types are exported from the main package:

import type {
  StripeProviderProps,
  StripeElementsProps,
  UseStripeReturn,
  UseStripeElementsReturn,
  UsePaymentIntentReturn,
  UseSetupIntentReturn,
  VueStripeOptions
} from '@vue-stripe/vue-stripe'