Ricardo's Universe
    • Back to home
    • StripeKit
    • Installation
    • Getting Started
    • Choosing a Mode
    • Type Reference
    • Setup
      • Configuration
      • Timezones
      • Storage Adapter
      • Money and Currency
      • Error Handling
    • Stripe
      • Elements
    • Modules
      • Overview
      • Customers
        • Overview
        • List
        • Retrieve
        • Find or Create by Email
        • Create
        • Update
        • Sync
        • Delete
      • Payment Methods
        • Overview
        • Create Setup Intent
        • List
        • Attach
        • Detach
        • Set Default
        • Sync
      • Payments
        • Overview
        • Pay With Saved Method
        • Create
        • Retrieve
        • Confirm
        • Cancel
        • Sync
      • Checkout
        • Overview
        • Get
        • Create
        • Submit Fields
        • Apply Coupon
        • Mark Complete
      • Subscriptions
        • Overview
        • Create
        • Retrieve
        • Cancel
        • Resume
        • Toggle Collection Method
        • Update Fields
        • Apply Promotion Code
        • List By Customer
        • Find By Metadata
        • Sync
      • Invoices
        • Overview
        • Retrieve
        • List By Customer
        • List By Subscription
        • Pay With Saved Method
        • Void
        • Finalize
        • Sync
      • Coupons
        • Overview
        • Create
        • Validate
        • Apply To Subscription
        • List
        • Deactivate
      • Webhooks
        • Overview
        • Process
        • Events Reference
      • Sync
        • Overview

    Installation

    Requirements#

    Node.js >= 18.x
    TypeScript >= 5.x (optional, but recommended)
    stripe ^17.0

    Install via npm, yarn or pnpm#

    If you plan to use Stripe Elements in the browser, also install:

    Stripe Elements (optional)#

    StripeKit includes optional browser-side helpers for Stripe Elements. These are only needed if you plan to use Elements mode in the browser.
    If you plan to use Stripe Elements in the browser, import the helper:
    The Elements helpers are client-side only and never run in Node.js.
    If you don't need Stripe Elements, you never have to import these helpers. See Stripe Elements details on using it.

    Package information#

    Package name@ricardoneudorfer/stripekit
    LicenseMIT
    ExportsStripeKit (main class), modular imports from @ricardoneudorfer/stripekit

    Next steps#

    Getting started
    Configuration
    Next
    Getting Started
    Built with