Documentation
    • 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#

    PHP >= 8.1
    ext-intl and ext-json (both installed automatically with most PHP distributions)
    stripe/stripe-php ^17.0 (installed automatically via Composer)

    Install via Composer#

    stripe/stripe-php is installed automatically as a dependency. No further setup is required to start using the API modules.

    Stripe Elements asset (optional)#

    StripeKit ships an optional browser-side helper for Stripe Elements at resources/js/stripekit-elements.js. This file is plain JavaScript and never runs in PHP, so it is only needed if you plan to use Elements mode.
    If you plan to use Stripe Elements in the browser, serve the bundled asset at:
    vendor/ricardoneudorfer/stripekit/resources/js/stripekit-elements.js
    from your public web root, or copy/symlink it into your own asset pipeline.
    If you don't need Stripe Elements, you never have to include this file. See Stripe Elements details on using it.

    Package information#

    Package namericardoneudorfer/stripekit
    LicenseMIT
    NamespaceStripeKit\ (PSR-4, mapped to src/)

    Next steps#

    Getting started
    Configuration
    Next
    Getting Started
    Built with