Get a list of recurring invoices
list_recurring_invoicesRetrieve paginated recurring invoices with their line items, and filter by status, date, or contact to find the records you need.
Instructions
Get a list of recurring invoices.
Get a paginated list of all recurring invoices with their line items.
[Recurring Invoices] GET /invoices/recurring
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number (default = 1). | |
| sort | No | Sort order. Format: field.direction (e.g. start_date.desc). Available fields: created, name, contact, number, type, period, start_date, end_date, invoice_date, amount. | |
| filter | No | Filter recurring invoices by status. | |
| records | No | Number of records per page. | |
| last_edit | No | Only return recurring invoices edited after this date (format: YYYY-mm-dd). | |
| relation_id | No | Only return recurring invoices for the relation with this ID. | |
| administration | No | The client administration to act on. Only one is configured: default. |