List the recurring series of the company
Oldest change first. A series that has ended is still active: a series ends by date, and has no cancelled state. updated_since narrows the list to what changed at or after an instant; the stamp is taken when the series is written, so a list is followed from the instant the last walk started, with no overlap. A change to a line alone does not move the stamp.
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
Query Parameters
How many records a page holds. Default 25, at most 100.
1 <= value <= 100The next_cursor of the page before.
1 <= lengthOnly the record that carries this external id.
1 <= length <= 255Only records changed at or after this ISO 8601 instant. The stamp is taken when the record is written, so a list is followed from the instant the last walk started: no overlap is needed.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$date-timeOnly series of this customer: its id, or ext:<external_id>.
1 <= length <= 255Value in
- "draft"
- "active"
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"{ "object": "list", "data": [ { "object": "recurring_series", "id": "string", "external_id": "string", "customer_id": "string", "customer_name": "string", "currency": "string", "frequency": "monthly", "start_date": "string", "end_date": "string", "issue_timing": { "mode": "start-of-period" }, "title": "string", "use_billing_period_as_title": true, "layout_ref": "string", "status": "draft", "cancelled_at": "string", "created_at": "string", "updated_at": "string", "lines": [ { "id": "string", "product_id": "string", "product_number": "string", "product_name": "string", "recognition_method": "value", "agreed_value": 0, "hourly_rate": 0, "discount": 0, "description_override": "string", "position": -9007199254740991, "assignees": [ { "user_id": "string", "distribution_percentage": 0, "hourly_rate_override": 0, "removed": true } ] } ] } ], "has_more": true, "next_cursor": "string"}Take a line of a recurring series away DELETE
With `this-and-following` the line stops from the occurrence `period` names; earlier occurrences keep it. With `this-only` it is absent from that one occurrence. A one-time line is removed under either scope. Refused with `DELETE_EMPTIES_OCCURRENCE` (409) when it would leave an occurrence that is already an invoice with no lines, and with `OCCURRENCE_ISSUED` (409) when the occurrence is issued.
Read one recurring series GET
Næste side