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

List

kit.customers.list()#

Lists customers from Stripe, optionally filtered by email, with cursor-based pagination.

Signature#

Parameters#

FieldTypeDefaultDescription
emailstringnoneReturn only customers with this exact email.
limitint20Maximum number of customers to return.
startingAfterstringnoneA customer ID to paginate after, taken from the id of the last item in a previous page.

Example request#

Example response#

A plain list (not paginated metadata, just the array of records):

Paginating#

Errors#

ExceptionWhen
StripeOperationErrorStripe rejects the request, for example an invalid startingAfter ID.

Notes#

list() does not write to your storage adapter. It is a read-only call against Stripe.
Previous
Overview
Next
Retrieve
Built with