API Reference

Complete API documentation for Vue Stripe components and composables.

Components

Provider Components

• VueStripeProvider - Root component that loads Stripe.js
• VueStripeElements - Creates Stripe Elements instance

Element Components

• VueStripePaymentElement - All-in-one payment UI (recommended)
• VueStripeExpressCheckoutElement - Apple Pay, Google Pay, Link
• VueStripeCardElement - Single card input
• Split Card Elements - Number + Expiry + CVC
• VueStripeAddressElement - Address collection
• VueStripeLinkAuthenticationElement - Link authentication

European Payment Elements

• VueStripeIbanElement - IBAN collection for SEPA payments
• VueStripeIdealBankElement - iDEAL bank selector (Netherlands)
• VueStripeP24BankElement - Przelewy24 bank selector (Poland)
• VueStripeEpsBankElement - EPS bank selector (Austria)

Checkout

• VueStripeCheckout - 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'