---
title: "Retorna uma lista de períodos."
method: GET
path: "/v1/periods"
tags: ["periods"]
---

# Retorna uma lista de períodos.

`GET /v1/periods`

Utilize este método para listar os períodos associadas à sua conta na Vindi. Leia a documentação sobre [paginação](http://atendimento.vindi.com.br/hc/pt-br/articles/203020644#pagination) e [filtros de busca](http://atendimento.vindi.com.br/hc/pt-br/articles/204163150).

#### Atributos para busca
<code>id</code>, <code>billing_at</code>, <code>subscription_id</code>, <code>start_at</code>, <code>end_at</code>, <code>cycle</code>, <code>duration</code>, <code>created_at</code> e <code>updated_at</code>.

## Query parameters

- `page` integer
- `per_page` integer
- `query` string
- `sort_by` 'id' | 'billing_at' | 'subscription_id' | 'start_at' | 'end_at' | 'cycle' | 'duration' | 'created_at' | 'updated_at'
- `sort_order` 'asc' | 'desc'

## Response `200`

Consulta realizada com sucesso.

- PeriodList[]
  - `id` integer, required — ID do período
  - `billing_at` string — Data para geração automática da cobrança do período
  - `cycle` integer, required — Ciclo do período
  - `start_at` string, required — Data e hora do início do período
  - `end_at` string, required — Data e hora do término do período
  - `duration` integer, required — Duração do período em número de segundos
  - `subscription` SubscriptionSummary
    - `id` integer, required — ID da assinatura
    - `code` string — Código externo para referência via API
    - `plan` PlanSummary, required
      - `id` integer, required — ID do plano
      - `name` string, required — Nome do plano
      - `code` string — Código externo do plano
    - `customer` CustomerSummary, required
      - `id` integer, required — ID do cliente
      - `name` string, required — Nome do cliente
      - `email` string — E-mail do cliente
      - `code` string — Código opcional para referência via API
  - `created_at` string, required — Data e hora da geração do período
  - `updated_at` string, required — Data e hora da última atualização do período

## Other responses

- `400` — Erro de sintaxe JSON no corpo do request.
- `422` — Parâmetros inválidos. Verificar erro na resposta.

---

[API](https://skmtc.net/vindi/apis/001-vindi-pagamentos-agost.md) · [All operations](https://skmtc.net/vindi/apis/001-vindi-pagamentos-agost/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vindi/001-vindi-pagamentos-agost/revisions/9d11e5de9308/schema)