---
title: "GET /api/subscriptions/cycles"
method: GET
path: "/api/subscriptions/cycles"
tags: ["api", "subscription-cycles"]
---

# GET /api/subscriptions/cycles

`GET /api/subscriptions/cycles`

Get all Subscription Cycles

## Query parameters

- `top` number, float — A limit on the number of objects to be returned. Can range between 1 and 1000.
- `skip` number, float — The number of objects to skip for the requested result
- `name` string — The name to filter for
- `planId` string — The plan ID to filter for
- `planVariantIds` string[] — An array of plan variant IDs to filter for

## Response `200`

OK

- GETSubscriptionCyclesGetAllSubscriptionCycles200Response
  - `docs` object[]
    - `_id` string, required — The ID of the subscription cycle
    - `name` string, required — The name of the subscription cycle
    - `status` 'DRAFT' | 'SCHEDULED' | 'ACTIVE' | 'COMPLETED', required — The status of the subscription cycle
    - `action` 'extension' | 'renewal' | 'status-change', required — The action of the subscription cycle
    - `planId` string, required — The ID of the plan of the subscription cycle
    - `planVariantIds` string[], required — The ID of the plan variant of the subscription cycle
    - `eventId` string, required — The ID of the event of the subscription cycle
    - `billing` object, nullable — The billing of the subscription cycle
    - `statusChange` object — The status change settings of the subscription cycle
      - `type` 'draft-to-active' | 'draft-to-canceled' — The type of the status change
    - `extension` object — The extension settings of the subscription cycle
      - `type` 'purchaseIntent' | 'freeticket' | 'transaction' — The type of the extension
      - `baseEventId` string — The Base Event Id from which the mapping of the extension starts
      - `targetEventId` string — The Target Event Id to which the mapping of the extension goes
      - `ticketTypeMapping` object — A mapping of the ticketTypes from the base event to the target event in key/value format where the key is the ticket type ID of a base event and the value is the ticket type ID of the target event
      - `keepSameBarcodes` boolean — Whether to keep the same barcode between base ticket and target ticket or not
      - `issueTickets` boolean — Whether the tickets should be issued or not on extension
    - `renewal` object — The renewal settings of the subscription cycle
      - `type` 'purchaseIntent' | 'subscription' — The type of the renewal
      - `status` string — The status of the renewal
      - `baseEventId` string — The Base Event Id from which the mapping of the renewal starts
      - `targetEventId` string — The Target Event Id to which the mapping of the renewal goes
      - `ticketTypeMapping` object — A mapping of the ticketTypes from the base event to the target event in key/value format where the key is the ticket type ID of a base event and the value is the ticket type ID of the target event
      - `keepSameBarcodes` boolean — Whether to keep the same barcode between base ticket and target ticket or not
      - `targetSubscriptionPlanId` string — The target subscription plan ID to which the mapping of the renewal goes
      - `subscriptionPlanVariantMapping` object — A mapping of the subscription plan variants from the base event to the target event in key/value format where the key is the subscription plan variant ID of a base event and the value is the subscription plan variant ID of the target event
    - `sellerId` string, required — The ID of the seller of the subscription cycle
    - `createdAt` string, date-time, required — An ISO timestamp indicating when the cycle was created
    - `updatedAt` string, date-time, required — An ISO timestamp indicating when the cycle was created
    - `startedAt` string, date-time — An ISO timestamp indicating when the cycle was created
    - `finishedAt` string, date-time — An ISO timestamp indicating when the cycle was created
    - `subscriptionsAffected` number, float — Amount of affected subscription after cycle applied
    - `deliverySettings` object — The delivery settings of the subscription cycle
      - `notifyCustomer` boolean — Whether the customer should be notified or not on cycle apply
    - `failedActions` object[] — An array of subscriptions which failed during subscription cycle action and related error
      - `subscriptionId` string, required — The subscription ID which failed in the subscription cycle action
      - `error` string — The error message why the subscription failed in the subscription cycle action
    - `subscriptionFilter` object — The subscription filters to apply to the subscriptions in the cycle. This is used to filter subscriptions that should be affected by the cycle
  - `total` integer

## Other responses

- `400` — Bad Request
- `401` — Unauthorized

---

[API](https://skmtc.net/vivenu/apis/vivenu-api.md) · [All operations](https://skmtc.net/vivenu/apis/vivenu-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vivenu/vivenu-api/revisions/36be0dca14e7/schema)