API Reference

List service plans

get
https://api.getrotor.com/open-api/service-plans

Returns a paginated list of service plan agreements for the authenticated company.
Results are ordered by creation date (newest first).

Service plans represent recurring service agreements (e.g. quarterly window cleaning, monthly pressure washing).
The sale_value is the total calculated contract value across all jobs in the plan.
The total_received is the net amount paid (invoices minus refunds) in dollars.

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
enum

Filter by active/inactive status

Allowed:
boolean

Filter by whether the service plan has been cancelled

boolean

Filter by whether the service plan has auto-pay enabled

string
enum

Filter by service frequency name.

string

Filter by service type (e.g. Window Cleaning, Pressure Washing)

uuid

Filter by the ID of the user who sold the plan

date-time

Return plans created on or after this date (ISO 8601)

date-time

Return plans created on or before this date (ISO 8601)

boolean

Filter by whether the customer has signed an agreement for the service plan

Headers
string
enum
required
Defaults to 1.1.0

Required OpenAPI version header.

Allowed:
Responses

Updated 28 days ago

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

Updated 28 days ago

Did this page help you?