Regenerate an invoice
Recalculates the invoice from the current order and subscription data, regenerates the stored PDF, and creates a new invoice version. Use this after upstream changes (for example order or billing updates) that should be reflected on an already-generated invoice. The existing stored PDF is replaced, and it may have already been sent to the customer. By default the regeneration is silent; pass send_invoice: true to also email the regenerated invoice to the buyer’s invoice recipients (reissue). Voided invoices and invoices that have not been generated yet cannot be regenerated.
The request blocks until the new PDF is stored, so a 200 means the regeneration is complete and any requested email has been sent.
Authorizations
API key for authentication
Path Parameters
^([a-zA-Z\d\-]+)$Body
If true, emails the regenerated invoice to the buyer's invoice recipients (reissue). Defaults to false: the invoice is regenerated silently and no emails are sent.
Response
Unique identifier for the invoice. If the id is null, this is an estimate
ID of the subscription this invoice belongs to. Null for standalone (one-off) invoices.
ID of the customer who will pay this invoice
Short form identifier for the invoice. If the invoice_number is null, this is an estimate
The date on which this invoice is expected to be paid by.
The date on which this invoice will be issued and potentially charged.
The date on which this invoice was issued.
Current status of the invoice. One of:
MUTED— Invoice will not be sent. Muted invoices come from migration cut-overs or from muting invoices in the product settings.SCHEDULED— Scheduled to be issued on a future date.OUTSTANDING— Issued and awaiting payment.DUE— Payment is due.PAST_DUE— Payment is past its due date.PAID— Fully paid.PARTIALLY_PAID— Partially paid, with a remaining balance.ADJUSTED— Adjusted after issuance.CREDITED— Settled by applying credit.UNPAID— Unpaid.PAUSED— Collection is paused.VOIDED— Voided and no longer collectible.
The date on which this invoice was fully paid.
Total amount due for this invoice.
Invoices that have not been generated yet (e.g. SCHEDULED) report the total expected at the time they were created. That figure does NOT include usage metered since — a usage invoice whose meters have not been priced reports 0. Pass ?calculate_expected_usage=true to re-price against the order and include estimated usage instead; it is slower, so it is off by default on list endpoints.
Remaining amount for this invoice.
The currency in which the invoice is denominated (e.g., USD, EUR).
This is an estimate for a renewal that has not yet closed, but is expected to.
Name of the customer who will pay this invoice
Invoice timezone
All payments made against this invoice, newest first.
Current attachments for this invoice as a flat array. Each item includes 'target' field indicating invoice or subscription level. Sorted by unified order.
Line item breakdown for this invoice
Optional metadata stored against the invoice.