List all invoices
GET / v1 / invoices
You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.
Parameters
- customer string Only return invoices for the customer specified by this customer ID.
- customer _ account string Only return invoices for the account representing the customer specified by this account ID.
- status enum The status of the invoice, one of
draft,open,paid,uncollectible, orvoid. Learn more - subscription string Only return invoices for the subscription specified by this subscription ID.
More parameters
- collection _ method enum
- created object
- ending _ before string
- limit integer
- starting _ after string
Returns
A dictionary with a data property that contains an array invoice attachments,
Response
Delete a draft invoice
DELETE / v1 / invoices /:id
Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be voided.
Parameters
No parameters.
Returns
A successfully deleted invoice. Otherwise, this call raises an error, such as if the invoice has already been deleted.
Response
{ "id": "in_1MtHbELkdIwHu7ixl4OzzPMv", "object": "invoice", "deleted": true}
Attach a payment to an Invoice
POST / v1 / invoices /:id / attach_payment
Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.
For the PaymentIntent, when the PaymentIntent’s status changes to succeeded, the payment is credited to the invoice, increasing its amount_paid. When the invoice is fully paid, the invoice’s status becomes paid.
If the PaymentIntent’s status is already succeeded when it’s attached, it’s credited to the invoice immediately.
See: Partial payments to learn more.
Parameters
- payment _ intent string The ID of the PaymentIntent to attach to the invoice.
- payment _ record string The ID of the PaymentRecord to attach to the invoice.
Returns
Returns the invoice object that the payment was attached to.
Response