Invoices ​
Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription.
They contain invoice items, and proration adjustments that may be caused by subscription upgrades/downgrades (if necessary).
If your invoice is configured to be billed through automatic charges, Stripe automatically finalizes your invoice and attempts payment. Note that finalizing the invoice, when automatic, does not happen immediately as the invoice is created. Stripe waits until one hour after the last webhook was successfully sent (or the last webhook timed out after failing). If you (and the platforms you may have connected to) have no webhooks configured, Stripe waits one hour after creation to finalize the invoice.
If your invoice is configured to be billed by sending an email, then based on your email settings, Stripe will email the invoice to your customer and await payment. These emails can contain a link to a hosted page to pay the invoice.
Stripe applies any customer credit on the account before determining the amount due for the invoice (i.e., the amount that will be actually charged). If the amount due for the invoice is less than Stripe’s minimum allowed charge per currency, the invoice is automatically marked paid, and we add the amount due to the customer’s credit balance which is applied to the next invoice.
More details on the customer’s credit balance are here.
Related guide: Send invoices to customers
Endpoints ​
Create a preview invoice ​
- POST /v1/invoices/create_preview
Create an invoice ​
- POST /v1/invoices
Update an invoice ​
- POST /v1/invoices/:id
Retrieve an invoice ​
- GET /v1/invoices/:id
List all invoices ​
- GET /v1/invoices
Delete a draft invoice ​
- DELETE /v1/invoices/:id
Attach a payment to an Invoice ​
- POST /v1/invoices/:id/attach_payment
Finalize an invoice ​
- POST /v1/invoices/:id/finalize
Mark an invoice as uncollectible ​
- POST /v1/invoices/:id/mark_uncollectible
Pay an invoice ​
- POST /v1/invoices/:id/pay
Search invoices ​
- GET /v1/invoices/search
Send an invoice for manual payment ​
- POST /v1/invoices/:id/send
Void an invoice ​
- POST /v1/invoices/:id/void
Events ​
invoice.createdOccurs whenever a new invoice is created. To learn how webhooks can be used with this event, and how they can affect it, see Using Webhooks with Subscriptions.invoice.deletedOccurs whenever a draft invoice is deleted. Note: This event is not sent for invoice previews.invoice.finalization_failedOccurs whenever a draft invoice cannot be finalized. See the invoice’s last finalization error for details.invoice.finalizedOccurs whenever a draft invoice is finalized and updated to be an open invoice.invoice.marked_uncollectibleOccurs whenever an invoice is marked uncollectible.invoice.overdueOccurs X number of days after an invoice becomes due - where X is determined by Automationsinvoice.overpaidOccurs when an invoice transitions to paid with a non-zero amount_overpaid.invoice.paidOccurs whenever an invoice payment attempt succeeds or an invoice is marked as paid out-of-band.invoice.payment_action_requiredOccurs whenever an invoice payment attempt requires further user action to complete.invoice.payment_attempt_requiredOccurs when an invoice requires a payment using a payment method that cannot be processed by Stripe.invoice.payment_failedOccurs whenever an invoice payment attempt fails, due to either a declined payment, including soft decline, or to the lack of a stored payment method.invoice.payment_succeededOccurs whenever an invoice payment attempt succeeds.invoice.sentOccurs whenever an invoice email is sent out.invoice.upcomingOccurs X number of days before a subscription is scheduled to create an invoice that is automatically charged - where X is determined by your subscriptions settings. Note: The receivedInvoiceobject will not have an invoice ID.invoice.updatedOccurs whenever an invoice changes (e.g., the invoice amount).invoice.voidedOccurs whenever an invoice is voided.invoice.will_be_dueOccurs X number of days before an invoice becomes due - where X is determined by Automations