Skip to main content
Service

Get a cycle by ID

Requires the service_plans:read scope.

GET
/cycles/{id}

Answers 404 for a cycle belonging to another company — to your key it does not exist.

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!

Path Parameters

idstringrequired

Cycle ID

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

Cycle retrieved successfully

dataobject

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.

statusstring
Example: success

Still need help? Ask the team