Recurring API
Manage recurring invoice schedules through the public `/recurring` API.
The public recurring API is:
/recurringDocumented Endpoints
| Method | Path | Purpose |
|---|---|---|
GET | /recurring | list recurring schedules |
GET | /recurring/upcoming | view upcoming scheduled work |
GET | /recurring/{id} | fetch one schedule |
POST | /recurring | create a schedule |
PATCH | /recurring/{id} | update a schedule |
DELETE | /recurring/{id} | delete a schedule |
POST | /recurring/{id}/pause | pause a schedule |
POST | /recurring/{id}/resume | resume a schedule |
POST | /recurring/{id}/cancel | cancel a schedule |
List and Upcoming Pages
GET /recurring and GET /recurring/upcoming both return paginated lists.
Query Parameters
| Parameter | Applies To | Description |
|---|---|---|
limit | both | Results per page (1-100, default 50) |
offset | both | Number of schedules to skip (default 0) |
status | /recurring | Filter schedules by lifecycle status |
days | /recurring/upcoming | Look-ahead window in days (1-365, default 30) |
Frequency Values
weeklybiweeklymonthly_datemonthly_weekdaymonthly_last_dayquarterlysemi_annualannualcustom
End Types
neveron_dateafter_count