List the occurrences of a recurring series
In the order of their periods, from the start of the series, or from from, to its end date, or to to. A series with no end date has no last occurrence: the list is walked a page at a time. Reading an occurrence never makes it an invoice.
Authorization
bearerAuth An API key minted by an admin under Settings → Developers. It is bound to one company and has a scope: read, or read_write. A request without one, or with one that is not ours, is answered 401 and metered by its client address (x-rate-limits).
In: header
Path Parameters
The record's id, or ext:<external_id> for the record that carries your own key.
Query Parameters
How many records a page holds. Default 25, at most 100.
1 <= value <= 100The next_cursor of the page before.
1 <= lengthOnly occurrences whose period starts on or after this day. Default: the start of the series.
^\d{4}-\d{2}-\d{2}$Only occurrences whose period starts on or before this day.
^\d{4}-\d{2}-\d{2}$Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/recurring-series/string/occurrences"{ "object": "list", "data": [ { "object": "occurrence", "series_id": "string", "period": "string", "period_from": "string", "period_to": "string", "issue_date": "string", "is_final_partial": true, "proration_factor": 0, "status": "scheduled", "invoice_id": "string", "title": "string" } ], "has_more": true, "next_cursor": "string"}Read one recurring series GET
Forrige side
Read one occurrence of a recurring series GET
The occurrence with its lines. One that is not issued states what the series’ lines come to on it after every change, with a final partial period’s value lines prorated; one that is issued states the lines its invoice was issued with. **Reading it never makes it an invoice**: an occurrence that is none yet answers `invoice_id: null`. A date that starts no period of the series is `OCCURRENCE_OUT_OF_RANGE` (404).