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
| Method | Description |
|---|---|
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
array{
id: string,
userId: string|int|null,
customerId: string|null,
subscriptionId: string|null,
paymentIntentId: string|null,
number: string|null,
amountDue: int,
amountPaid: int,
subtotal: int,
taxAmount: int,
taxRate: mixed|null,
currency: string,
status: string,
description: string|null,
hostedInvoiceUrl: string|null,
lineItems: list<array{description: string, amount: int, currency: string, quantity: int, taxAmount: int}>,
dueAtUtc: string|null,
paidAtUtc: string|null,
issuedAtUtc: string,
dueAtLocal: string|null,
paidAtLocal: string|null,
issuedAtLocal: string,
}status mirrors Stripe's own invoice statuses: 'draft', 'open', 'paid', 'uncollectible', 'void'.