---
title: "Retorna uma lista de registros de utilização para um período específico."
method: GET
path: "/v1/periods/{id}/usages"
tags: ["periods"]
---

# Retorna uma lista de registros de utilização para um período específico.

`GET /v1/periods/{id}/usages`

## Request

- Base URL: `//app.vindi.com.br/api` (relative, and the document’s source URL is not known)
- URL: `//app.vindi.com.br/api/v1/periods/{id}/usages`
- Auth: HTTP basic

Utilize este método para listar os registros de utilização associados ao período desejado. Leia a documentação sobre [paginação](http://atendimento.vindi.com.br/hc/pt-br/articles/203020644#pagination).

## Path parameters

- `id` integer, required

## Query parameters

- `page` integer
- `per_page` integer

## Response `200`

Ok. Período encontrado.

- Usage[]
  - `id` integer, required: ID do registro de utilização
  - `description` string: Descrição opcional
  - `created_at` string, required: Data e hora da geração do registro de utilização
  - `metadata` object: Metadados do registro de utilização
  - `product_item` ProductItemSummary, required
    - `id` integer, required: ID do item
    - `product` ProductSummary, required
      - `id` integer, required: ID do produto
      - `name` string, required: Nome do produto
      - `code` string: Código externo do produto
  - `bill` BillSummary
    - `id` integer, required: ID da fatura
    - `code` string: Código externo para referência via API
  - `quantity` integer, required: Quantidade informada no registro de utilização

## Other responses

- `400`: Erro de sintaxe JSON no corpo do request.
- `404`: Período não encontrado.
- `422`: Parâmetros inválidos. Verificar erro na resposta.

---

[API](https://skmtc.dev/vindi/apis/api-vindi.md) - [All operations](https://skmtc.dev/vindi/apis/api-vindi/llms.txt) - [OpenAPI document](https://skmtc.dev/vindi/apis/api-vindi/revisions/3e857e1cdd03?raw)