1. Modules
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
  1. Modules

Overview

Every action StripeKit can perform is available under $kit-><module>-><action>(). Initialize StripeKit once and share the instance across your app.
ModulePurposeDocumentation
$kit->customersCreate, retrieve, update, delete and list Stripe customers.Customers
$kit->paymentMethodsList, attach, detach and set default payment methods.Payment methods
$kit->paymentsOne-off payments (PaymentIntents), respecting the configured mode.Payments
$kit->checkoutBuild a custom checkout flow: one-off payments or subscriptions, with custom fields and coupons.Checkout
$kit->subscriptionsCreate, retrieve, cancel, resume and update subscriptions.Subscriptions
$kit->invoicesRetrieve, list, pay, void and finalize invoices.Invoices
$kit->couponsCreate, validate, apply and deactivate coupons and promotion codes.Coupons
$kit->webhooksVerify, deduplicate and process incoming Stripe webhook events.Webhooks
$kit->syncPull the full current state of a customer from Stripe on demand.Sync
Each module page links to a separate page per method, with the full parameter table, an example request, an example response, and every exception it can throw.
See also:
Error handling
Money and currency
Stripe Elements
Storage adapter
Type reference
Previous
Elements
Next
Overview
Built with