List recurring-billing cycles

Returns a paginated list of recurring-billing cycles for the authenticated
company. Results are ordered by created_at (newest first).

A cycle owns the cadence, amount and next billing date behind a service plan's
recurring charge — the service plan's own fields do not. Follow
billing_cycle_ids from a service plan or a serviced job to get here.

Cancelled and rollup cycles are included. Filter them out with status and
pricing_mode if you do not want them; they are returned by default so that a
sync does not read an omitted row as a deletion.

next_amount is in dollars, and is null for rollup cycles, which charge
whatever work is outstanding when the period closes.

Requires the service_plans:read scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 1

Page number (1-based)

integer
1 to 1000
Defaults to 50

Number of results per page (max 1000)

string

Comma-separated list of statuses to include

string
enum
Allowed:
uuid

Only cycles billing this customer

uuid

Only cycles that bill this service plan

date

Cycles whose next charge falls on or after this calendar date

date

Cycles whose next charge falls on or before this calendar date

date-time
date-time
Headers
string
enum
required
Defaults to 1.1.0

Required OpenAPI version header.

Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json