---
title: "Listar ciclos"
url: "https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5/operations/listar-ciclos-1"
---

> Full API specification: https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5.md

# Listar ciclos

`GET` `/subscriptions/{subscription_id}/cycles`

Operation ID: `listar-ciclos-1`

Este recurso permite listar os ciclos associados a uma assinatura. Podem ser utilizados alguns parâmetros como filtro da listagem.

## Path parameters

- `subscription_id` (string, required) - Código da assinatura.

## Query parameters

- `id` (string, optional) - _Código do ciclo_. Formato: `cycle_XXXXXXXXXXXXXXXX`.
- `billing_at` (string, date, optional) - Data de cobrança do ciclo
- `cycle` (string, optional) - Quantidade de ciclos na assinatura
- `start_at` (string, optional) - Data de início do ciclo
- `end_at` (string, optional) - Data final do ciclo
- `duration` (string, optional)
- `created_at` (string, optional) - Data de criação da assinatura
- `updated_at` (string, date, optional) - Data de atualização do ciclo da assinatura.
- `status` (string, optional) - Status dos ciclos. Valores possíveis: **billed** ou **unbilled**

## Responses

- `200` - 200
- `400` - 400

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Pagar.me v5 API (Legado)
  version: 5.0.0
servers:
  - url: https://api.stone.com.br/core/v5
paths:
  /subscriptions/{subscription_id}/cycles:
    get:
      summary: Listar ciclos
      description: Este recurso permite listar os ciclos associados a uma assinatura.
        Podem ser utilizados alguns parâmetros como filtro da listagem.
      operationId: listar-ciclos-1
      parameters:
        - name: subscription_id
          in: path
          description: Código da assinatura.
          schema:
            type: string
          required: true
        - name: id
          in: query
          description: "_Código do ciclo_. Formato: `cycle_XXXXXXXXXXXXXXXX`."
          schema:
            type: string
        - name: billing_at
          in: query
          description: Data de cobrança do ciclo
          schema:
            type: string
            format: date
        - name: cycle
          in: query
          description: Quantidade de ciclos na assinatura
          schema:
            type: string
        - name: start_at
          in: query
          description: Data de início do ciclo
          schema:
            type: string
        - name: end_at
          in: query
          description: Data final do ciclo
          schema:
            type: string
        - name: duration
          in: query
          schema:
            type: string
        - name: created_at
          in: query
          description: Data de criação da assinatura
          schema:
            type: string
        - name: updated_at
          in: query
          description: Data de atualização do ciclo da assinatura.
          schema:
            type: string
            format: date
        - name: status
          in: query
          description: "Status dos ciclos. Valores possíveis: **billed** ou **unbilled**"
          schema:
            type: string
      responses:
        "200":
          description: "200"
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "data": [
                            {
                                "id": "cycle_Qal5a0LCpphoDpnR",
                                "billing_at": "2019-04-30T00:00:00Z",
                                "cycle": 1,
                                "start_at": "2019-04-30T00:00:00Z",
                                "end_at": "2019-07-29T23:59:59Z",
                                "duration": 7862399,
                                "created_at": "2019-04-30T18:09:32Z",
                                "updated_at": "2019-04-30T18:09:33Z",
                                "status": "billed"
                            }
                        ],
                        "paging": {
                            "total": 1
                        }
                    }
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: cycle_Qal5a0LCpphoDpnR
                        billing_at:
                          type: string
                          example: 2019-04-30T00:00:00Z
                        cycle:
                          type: integer
                          example: 1
                          default: 0
                        start_at:
                          type: string
                          example: 2019-04-30T00:00:00Z
                        end_at:
                          type: string
                          example: 2019-07-29T23:59:59Z
                        duration:
                          type: integer
                          example: 7862399
                          default: 0
                        created_at:
                          type: string
                          example: 2019-04-30T18:09:32Z
                        updated_at:
                          type: string
                          example: 2019-04-30T18:09:33Z
                        status:
                          type: string
                          example: billed
                  paging:
                    type: object
                    properties:
                      total:
                        type: integer
                        example: 1
                        default: 0
        "400":
          description: "400"
          content:
            application/json:
              examples:
                Result:
                  value: "{}"
              schema:
                type: object
                properties: {}
      deprecated: false
security:
  - sec0: []
components:
  securitySchemes:
    sec0:
      type: http
      scheme: basic
```