Invoices
List invoices
List invoices, newest first.
GET/v1/invoices
Parameters
| Parameter | Description |
|---|---|
| customer_idstring | null · queryoptional | At most 64 characters. |
| subscription_idstring | null · queryoptional | At most 64 characters. |
| payment_idstring | null · queryoptional | At most 64 characters. |
| statusstring | null · queryoptional | At most 32 characters. |
| limitinteger · queryoptional | Defaults to 10. Between 1 and 100. |
| starting_afterstring | null · queryoptional | At most 128 characters. |
| expandstring | null · queryoptional | At most 256 characters. |
Cursor-paginated. limit caps a page and starting_after takes the last id you
saw.
Returns
Returns a page of InvoiceResponse objects. data holds the page and has_more says whether another one exists. Page forward by passing the last id of the page as starting_after; a short page is not the end of the list.
Errors
| Status | Cause |
|---|---|
| 401 | Missing or invalid API key. |
| 403 | Key is missing the invoices:read scope. |
| 422 | Validation Error |
| 429 | Rate limited. Back off and retry. |
Other invoices operations
- Get invoice GET /v1/invoices/{invoice_id}
- Email invoice POST /v1/invoices/{invoice_id}/email
- Get invoice PDF GET /v1/invoices/{invoice_id}/pdf
- Void invoice route POST /v1/invoices/{invoice_id}/void
BillKit