---
updatedAt: 2026-08-19T16:56:02.000Z
agentTools:
  projectIndex: https://docs.api.getrotor.com/llms.txt
---

# List recurring-billing cycles

Returns a paginated list of recurring-billing cycles for the authenticated
company. Results are ordered by `created_at` (newest first).

A cycle owns the cadence, amount and next billing date behind a service plan's
recurring charge — the service plan's own fields do not. Follow
`billing_cycle_ids` from a service plan or a serviced job to get here.

Cancelled and `rollup` cycles are included. Filter them out with `status` and
`pricing_mode` if you do not want them; they are returned by default so that a
sync does not read an omitted row as a deletion.

`next_amount` is in dollars, and is null for `rollup` cycles, which charge
whatever work is outstanding when the period closes.

Requires the `service_plans:read` scope.


# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Rotor OpenAPI",
    "description": "Public-facing API for Rotor — a CRM and field service platform built for home service businesses.\n\nCurrent version: `1.1.0`\n\n## Authentication\n\nAll requests must be authenticated with a company API key.\n\n- Header: `x-api-key: rotor_{keyId}_{keySecret}`\n- Version header: `rotor-api-version: 1.1.0`\n\nAPI keys are scoped to a specific company and can be managed by company administrators in **Settings → Integrations → API Keys**.\n\n## Rate Limits\n\nEach API key is limited to **1000 requests per UTC day** across all OpenAPI endpoints.\n\n## Scopes\n\nEach API key is granted specific scopes that control what actions it can perform:\n\n| Scope | Description |\n|---|---|\n| `leads:create` | Create and update leads |\n| `leads:read` | Read lead records |\n| `customers:create` | Create and update customers |\n| `customers:read` | Read customer records |\n| `service_plans:read` | Read service plan records |\n| `jobs:read` | Read serviced job records |\n| `pins:read` | Read pin records and pin types |\n| `timesheets:read` | Read timesheet records and visit timer records |\n| `tasks:read` | Read task records |\n| `tasks:create` | Create tasks |\n| `tasks:update` | Update tasks |\n| `configuration:read` | Read company configuration (service types, line item templates) |\n\n## Getting Started\n\n1. **Set the required version header**: Send `rotor-api-version: 1.1.0` with every request\n2. **Create an API key**: Go to Settings → Integrations → API Keys, create a key with the scopes you need\n3. **For testing**: Use `GET /auth/test` to verify your credentials\n",
    "version": "1.1.0",
    "contact": {
      "name": "Rotor API Support",
      "url": "https://getrotor.com"
    }
  },
  "servers": [
    {
      "url": "https://api.getrotor.com/open-api",
      "description": "Production server"
    },
    {
      "url": "http://localhost:3000/open-api",
      "description": "Development server"
    }
  ],
  "security": [
    {
      "ApiKey": []
    }
  ],
  "paths": {
    "/cycles": {
      "get": {
        "summary": "List recurring-billing cycles",
        "description": "Returns a paginated list of recurring-billing cycles for the authenticated\ncompany. Results are ordered by `created_at` (newest first).\n\nA cycle owns the cadence, amount and next billing date behind a service plan's\nrecurring charge — the service plan's own fields do not. Follow\n`billing_cycle_ids` from a service plan or a serviced job to get here.\n\nCancelled and `rollup` cycles are included. Filter them out with `status` and\n`pricing_mode` if you do not want them; they are returned by default so that a\nsync does not read an omitted row as a deletion.\n\n`next_amount` is in dollars, and is null for `rollup` cycles, which charge\nwhatever work is outstanding when the period closes.\n\nRequires the `service_plans:read` scope.\n",
        "operationId": "listCycles",
        "tags": [
          "Service"
        ],
        "security": [
          {
            "ApiKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/RotorApiVersionHeader"
          },
          {
            "$ref": "#/components/parameters/PageParam"
          },
          {
            "$ref": "#/components/parameters/LimitParam"
          },
          {
            "name": "status",
            "in": "query",
            "description": "Comma-separated list of statuses to include",
            "schema": {
              "type": "string"
            },
            "example": "active,past_due"
          },
          {
            "name": "pricing_mode",
            "in": "query",
            "schema": {
              "type": "string",
              "enum": [
                "fixed",
                "rollup",
                "variable"
              ]
            },
            "example": "fixed"
          },
          {
            "name": "customer_id",
            "in": "query",
            "description": "Only cycles billing this customer",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "service_plan_id",
            "in": "query",
            "description": "Only cycles that bill this service plan",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "next_billing_date_range_start",
            "in": "query",
            "description": "Cycles whose next charge falls on or after this calendar date",
            "schema": {
              "type": "string",
              "format": "date"
            },
            "example": "2026-09-01"
          },
          {
            "name": "next_billing_date_range_end",
            "in": "query",
            "description": "Cycles whose next charge falls on or before this calendar date",
            "schema": {
              "type": "string",
              "format": "date"
            },
            "example": "2026-09-30"
          },
          {
            "name": "created_at_range_start",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "created_at_range_end",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Cycles listed successfully",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/PaginatedResponse"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Cycle"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "RotorApiVersionHeader": {
        "name": "rotor-api-version",
        "in": "header",
        "description": "Required OpenAPI version header.",
        "required": true,
        "schema": {
          "type": "string",
          "enum": [
            "1.1.0"
          ],
          "default": "1.1.0"
        },
        "example": "1.1.0"
      },
      "PageParam": {
        "name": "page",
        "in": "query",
        "description": "Page number (1-based)",
        "schema": {
          "type": "integer",
          "minimum": 1,
          "default": 1
        },
        "example": 1
      },
      "LimitParam": {
        "name": "limit",
        "in": "query",
        "description": "Number of results per page (max 1000)",
        "schema": {
          "type": "integer",
          "minimum": 1,
          "maximum": 1000,
          "default": 50
        },
        "example": 50
      }
    },
    "responses": {
      "Unauthorized": {
        "description": "Authentication required",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "example": {
              "status": "error",
              "message": "Authentication required. Provide x-api-key header.",
              "error_code": "AUTHENTICATION_REQUIRED"
            }
          }
        }
      },
      "Forbidden": {
        "description": "Insufficient scope",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "example": {
              "status": "error",
              "message": "Forbidden: required scope 'leads:read' not granted for this API key",
              "error_code": "INSUFFICIENT_SCOPE"
            }
          }
        }
      },
      "TooManyRequests": {
        "description": "Daily API key rate limit exceeded",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "example": {
              "status": "error",
              "message": "Daily API key request limit of 1000 exceeded",
              "error_code": "RATE_LIMIT_EXCEEDED"
            }
          }
        }
      },
      "InternalError": {
        "description": "Internal server error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "example": {
              "status": "error",
              "message": "Internal server error"
            }
          }
        }
      }
    },
    "schemas": {
      "PaginatedResponse": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "example": "success"
          },
          "pagination": {
            "type": "object",
            "properties": {
              "page": {
                "type": "integer",
                "example": 1
              },
              "limit": {
                "type": "integer",
                "example": 50
              },
              "total": {
                "type": "integer",
                "description": "Total number of matching records",
                "example": 142
              },
              "has_more": {
                "type": "boolean",
                "description": "Whether more pages are available",
                "example": true
              }
            }
          }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "example": "error"
          },
          "message": {
            "type": "string",
            "example": "Validation failed"
          },
          "error_code": {
            "type": "string",
            "description": "Machine-readable error code",
            "example": "INSUFFICIENT_SCOPE"
          },
          "limit": {
            "type": "integer",
            "description": "Daily request limit for the API key when rate limited",
            "example": 1000
          },
          "requests_today": {
            "type": "integer",
            "description": "Number of requests already consumed today by the API key",
            "example": 1000
          },
          "reset_at": {
            "type": "string",
            "format": "date-time",
            "description": "UTC timestamp when the daily request counter resets",
            "example": "2026-03-31T00:00:00Z"
          },
          "errors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "field": {
                  "type": "string",
                  "example": "email"
                },
                "message": {
                  "type": "string",
                  "example": "Invalid email format"
                }
              }
            }
          }
        }
      },
      "ServicePlanCustomer": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "first_name": {
            "type": "string"
          },
          "last_name": {
            "type": "string"
          },
          "company_name": {
            "type": "string"
          }
        }
      },
      "Cycle": {
        "type": "object",
        "description": "A recurring-billing cycle: the cadence, amount and schedule behind a service plan's recurring charge. The cycle — not the service plan — owns these, so it is the authoritative answer to what a customer will be charged and when.\n",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          },
          "name": {
            "type": "string",
            "nullable": true,
            "example": "Lawn care plan"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "paused",
              "past_due",
              "cancelled"
            ],
            "description": "A `past_due` cycle is still billing — it is retrying a failed charge.",
            "example": "active"
          },
          "pricing_mode": {
            "type": "string",
            "enum": [
              "fixed",
              "rollup",
              "variable"
            ],
            "description": "`fixed` charges `next_amount` every period. `rollup` charges whatever work is outstanding when the period closes, so it has no forward amount. `variable` charges for the plan's visits: `next_amount` is what the next charge collects and is recomputed each period from the plan's schedule.\n",
            "example": "fixed"
          },
          "frequency_interval": {
            "type": "string",
            "enum": [
              "day",
              "week",
              "month",
              "year"
            ],
            "example": "month"
          },
          "frequency_interval_count": {
            "type": "number",
            "example": 1
          },
          "frequency_label": {
            "type": "string",
            "description": "Human-readable cadence.",
            "example": "Monthly"
          },
          "day_of_month": {
            "type": "number",
            "nullable": true,
            "description": "Month and year cadences re-anchor to this day each period.",
            "example": 8
          },
          "currency": {
            "type": "string",
            "description": "Lowercase ISO-4217, from the company's Stripe account.",
            "example": "usd"
          },
          "next_amount": {
            "type": "number",
            "nullable": true,
            "description": "What the next charge will be, in dollars. Always null for `pricing_mode: rollup`, which has no fixed amount.\n",
            "example": 125
          },
          "start_date": {
            "type": "string",
            "example": "2026-01-08"
          },
          "current_period_start": {
            "type": "string",
            "nullable": true
          },
          "current_period_end": {
            "type": "string",
            "nullable": true
          },
          "next_billing_date": {
            "type": "string",
            "nullable": true,
            "description": "Calendar date, `YYYY-MM-DD`. Null until the cycle is anchored.",
            "example": "2026-09-08"
          },
          "is_auto_pay": {
            "type": "boolean",
            "description": "Whether the next charge is taken automatically. False means an invoice is emailed for the customer to pay. Derived from the plan the cycle bills, so a cycle with no plan attached reports false. Not filterable for that reason.\n"
          },
          "is_payment_failed": {
            "type": "boolean",
            "description": "The cycle is behind on its own charge and is retrying."
          },
          "failed_attempt_count": {
            "type": "number",
            "example": 0
          },
          "retry_billing_date": {
            "type": "string",
            "nullable": true
          },
          "paused_at": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "pause_reason": {
            "type": "string",
            "nullable": true
          },
          "cancelled_at": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "cancelled_reason": {
            "type": "string",
            "nullable": true
          },
          "customer": {
            "$ref": "#/components/schemas/ServicePlanCustomer"
          },
          "service_plan_ids": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "uuid"
            },
            "description": "Service plans this cycle bills. Empty for a standalone cycle."
          }
        },
        "required": [
          "id",
          "status",
          "pricing_mode",
          "frequency_interval",
          "frequency_interval_count",
          "currency",
          "is_auto_pay",
          "service_plan_ids"
        ]
      }
    },
    "securitySchemes": {
      "ApiKey": {
        "type": "apiKey",
        "in": "header",
        "name": "x-api-key",
        "description": "Company API key in the format: `rotor_{keyId}_{keySecret}`\n\nTo obtain an API key:\n1. Log into your Rotor dashboard\n2. Go to Settings → Integrations → API Keys\n3. Create a new key and select the scopes you need\n4. Copy the key — it's only shown once!\n"
      }
    }
  },
  "tags": [
    {
      "name": "Service",
      "description": "Read service plans and completed job records"
    }
  ]
}
```