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

Overview

kit.invoices reads, pays, voids and finalizes Stripe invoices, and normalizes every line item plus both UTC and local timestamps for due, paid and issued dates.

Methods#

MethodDescription
retrieve()Fetch a single invoice by ID.
listByCustomer()List a customer's invoices, optionally filtered by status.
listBySubscription()List invoices belonging to a subscription.
payWithSavedMethod()Pay an open invoice with a saved payment method.
voidInvoice()Void an invoice that hasn't been paid.
finalize()Finalize a draft invoice so it can be paid.
sync()Re-pull an invoice from Stripe and persist it via your storage adapter.

The KitInvoiceRecord shape#

status mirrors Stripe's own invoice statuses: 'draft', 'open', 'paid', 'uncollectible', 'void'.
Previous
Sync
Next
Retrieve
Built with