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

List By Customer

kit.invoices.listByCustomer()#

Lists a customer's invoices, optionally filtered by status.

Signature#

Parameters#

FieldTypeRequiredDescription
customerIdstringYesThe customer to list invoices for.
statusstring|nullNo'draft', 'open', 'paid', 'uncollectible', or 'void'. Omit for all statuses.
limitnumberNo, defaults to 20Maximum number of invoices to return.

Example request#

Example response#

A plain list, same shape as retrieve() per item.

Errors#

ExceptionWhen
StripeOperationErrorThe customer ID does not exist.

Notes#

This call does not write to your storage adapter, and does not support cursor pagination beyond limit. For large invoice histories, use the underlying Stripe client directly via kit.raw.
Previous
Retrieve
Next
List By Subscription
Built with