Skip to main content
Service plans

Create an inactive service plan (no jobs, no billing)

POST
/service-plans
Authorizationstringheaderrequired

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

Body

application/json
auto_renewbooleandefault:true

Default true: the plan renews at the end of its term.

billing_modeenum<string>required
Available options: after_jobs, cycle, start_of_month
customer_idstringrequired
cycleobject

Required when billing_mode is cycle; not allowed otherwise.

discountsobject[]
frequencyobjectrequired
is_auto_payboolean

Default false. True needs a saved payment method for the customer.

line_itemsobject[]required
Required array length: 1 - 50
namestring
notesstring
property_idinteger

An active property of the customer. Omitted: the customer address.

Required range: 0 < x
service_length_monthsinteger

Term in months, 1-120. Default 12.

Required range: 1 <= x <= 120
service_typesstring[]

Names from the company service types (GET /configuration), matched case-insensitively.

Maximum array length: 20
sold_bystring | null

An active member of the company (see GET /users).

start_datestringrequired
tax_rate_idstring

Response

application/json

The created service plan

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

activebooleanrequired
auto_renewbooleanrequired
billing_modeenum<string>required
Available options: after_jobs, cycle, start_of_month
cancelledbooleanrequired
cancelled_atstring | nullrequired
cancelled_reasonstring | nullrequired
created_atstringrequired
customerobject | nullrequired
cycle_idsstring[]required
discountsobject[]required
end_datestring | nullrequired
frequencyobjectrequired
from_quote_idstring | nullrequired
has_payment_methodbooleanrequired
idstringrequired
is_auto_paybooleanrequired
is_signedbooleanrequired
job_countsobjectrequired

Live jobs by status (archived and quote jobs excluded): scheduled is Scheduled or In Progress, completed is Completed, pending is Pending. A plan with no jobs yet (not scheduled) projects pending from its length; cancelled jobs are not counted.

line_itemsobject[]required
namestring | nullrequired
notesstring | nullrequired
property_addressobjectrequired
sale_valuenumber | nullrequired
service_length_monthsintegerrequired
service_typesstring[]required
sold_byobject | nullrequired
start_datestringrequired
tax_rate_idstring | nullrequired
total_receivednumberrequired