Skip to main content
Service plans

List service plans

GET
/service-plans
Authorizationstringheaderrequired

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

limitintegerquerydefault:25
Required range: 1 <= x <= 100
cursorstringquery
include_totalenum<string>querydefault:false

When true, total is a full count of matching records and costs an extra query. Otherwise total is null.

Available options: true, false
customer_idstringquery
statusenum<string>query
Available options: active, inactive
cancelledenum<string>query
Available options: true, false
is_auto_payenum<string>query
Available options: true, false
is_signedenum<string>query
Available options: true, false
billing_modeenum<string>query
Available options: after_jobs, cycle, start_of_month
service_typestringquery
Required string length: 1 - 100
sold_by_user_idstringquery
created_afterstringquery
created_beforestringquery

Response

application/json

A page of service plans, newest first

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).

dataobject[]required
has_morebooleanrequired
next_cursorstring | nullrequired
previous_cursorstring | nullrequired
totalinteger | nullrequired

Null unless include_total=true.

Required range: 0 <= x