Skip to main content
Service

List service plans

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

GET
/service-plans

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.

Authorizations

x-api-keystringheaderrequired

Company API key in the format: rotor_{keyId}_{keySecret}

To obtain an API key:

  1. Log into your Rotor dashboard
  2. Go to Settings → Integrations → API Keys
  3. Create a new key and select the scopes you need
  4. Copy the key — it's only shown once!

Query Parameters

pageintegerquerydefault:1

Page number (1-based)

Required range: 1 <= x
Example: 1
limitintegerquerydefault:50

Number of results per page (max 1000)

Required range: 1 <= x <= 1000
Example: 50
statusenum<string>query

Filter by active/inactive status

Available options: active, inactive
Example: active
cancelledbooleanquery

Filter by whether the service plan has been cancelled

Example: false
is_auto_paybooleanquery

Filter by whether the service plan has auto-pay enabled

Example: true
billing_modeenum<string>query

Filter by how the service plan is billed

Available options: after_jobs, cycle, start_of_month
Example: after_jobs
frequencyenum<string>query

Filter by service frequency name.

Available options: One-Time, Annual, Semi-Annual, Tri-Annual, Quarterly, Bi-Monthly, Monthly, Bi-Weekly, Weekly, Custom
Example: One-Time
service_typestringquery

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

Example: Window Cleaning
sold_by_user_idstringquery

Filter by the ID of the user who sold the plan

created_at_range_startstringquery

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

Example: 2026-01-01T00:00:00Z
created_at_range_endstringquery

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

Example: 2026-12-31T23:59:59Z
is_signedbooleanquery

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

Example: true

Headers

rotor-api-versionenum<string>headerdefault:1.1.0required

Required OpenAPI version header.

Available options: 1.1.0
Example: 1.1.0

Response

application/json

Service plans listed successfully

dataobject[]
paginationobject
statusstring
Example: success

Still need help? Ask the team