GET /api/invoices/{id}/status to check an invoice’s current payment status and whether it is overdue. This is a lightweight endpoint designed for frequent polling — the hosted invoice page uses it to update the payment confirmation UI in real time. It returns only status and overdue, so it is much cheaper than fetching the full invoice record.
Request
Path parameters
The invoice UUID returned as
invoice_id when you created the invoice.Example request
cURL
Response
A successful request returns200 OK with the following fields.
The current payment status of the invoice. See the table below for all possible values.
true if today’s date is past the invoice due_date and the invoice has not reached paid status.Status values
| Value | Meaning |
|---|---|
draft | The invoice was created with send_now: false and has not been emailed to the vendor yet. |
sent | The vendor has been emailed the invoice and no payment has been detected. |
paid | The exact amount was received — payment is complete. |
partial | Less than the total amount was received. The invoice is still awaiting the remaining balance. |
excess | More than the total amount was received. |
Example response
200