Skip to main content
Service plans

Get a billing cycle

GET
/cycles/{id}
Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

idstringrequired

Response

application/json

The cycle

X-RateLimit-Limitintegerheader

The company's daily request limit.

X-RateLimit-Remainingintegerheader

Requests left in the current daily window.

X-RateLimit-Resetstringheader

When the daily window resets (UTC ISO timestamp).

X-RateLimit-Minute-Limitintegerheader

The company's per-minute request limit.

X-RateLimit-Minute-Remainingintegerheader

Requests left in the current minute.

X-RateLimit-Minute-Resetstringheader

When the minute window resets (UTC ISO timestamp).

amountnumber | nullrequired

Dollars per period; null for a rollup, or a variable cycle with no amount set.

created_atstringrequired
customer_idstringrequired
day_of_monthinteger | nullrequired

Day of the month the cycle bills on; null when not pinned to one.

frequencyobjectrequired
idstringrequired
is_auto_paybooleanrequired
next_billing_datestring | nullrequired
pricing_modeenum<string>required

fixed: amount each period. rollup: the completed jobs in the period. variable: amount set per cycle.

Available options: fixed, rollup, variable
service_plan_idsstring[]required
statusenum<string>required
Available options: active, paused, past_due, cancelled