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

Get

kit.checkout.get()#

Fetches the current state of a checkout session, including any custom field values already submitted.

Signature#

Example request#

Example response#

Same shape as create()'s response, plus fieldValues and status:
status is one of 'open' or 'complete' (set by markComplete()).

Errors#

ExceptionWhen
NotFoundErrorNo checkout session with that ID is found in storage, or it has expired from the in-process fallback store (for example, after a server restart). This is the single most common source of "checkout session not found" errors when no storage adapter is configured, see Storage adapter.

Notes#

This reads from your storage adapter (or in-process memory), never from Stripe directly. It reflects the state StripeKit itself is tracking, not necessarily the live Stripe object.
Previous
Overview
Next
Create
Built with