---
title: "Consumo do ciclo de cobrança atual"
method: GET
path: "/v1/usage"
tags: ["Conta"]
---

# Consumo do ciclo de cobrança atual

`GET /v1/usage`

## Request

- Base URL: `https://api.sudrel.com.br/api`
- URL: `https://api.sudrel.com.br/api/v1/usage`
- Auth: HTTP bearer

Franquia, consumo e excedente do ciclo em andamento. A chave de teste
de emissão (`sdr_test_...`) vê o mesmo consumo da conta; nota de teste
nunca entra na franquia.

## Response `200`

OK

- Consumo: Só o ciclo do produto **Recebidas**. O consumo da Emissão não aparece aqui. Sem ciclo, a resposta traz só `temCicloAtivo: false`, `acessoProdutos` e `planoMinimoRecebidas`.
  - `temCicloAtivo` boolean
  - `acessoProdutos` object
    - `recebidas` boolean
    - `emissao` boolean
  - `planoMinimoRecebidas` object, nullable: Se a conta precisa de um plano maior pelo número de CNPJs monitorados.
  - `ciclo` Ciclo
    - `id` string
    - `status` 'ATIVO' | 'TOLERANCIA' | 'ENCERRADO'
    - `dataInicio` string, date-time
    - `dataFim` string, date-time
    - `plano` Plano
      - `id` string
      - `nome` string
      - `precoMensal` string: Valor decimal em reais, como string (evita perda de precisão de ponto flutuante).
      - `franquiaEventos` integer
      - `precoUnitarioExcedente` string
      - `percentualDescontoAnual` string, nullable
      - `produto` 'RECEBIDAS' | 'EMISSAO'
      - `trial` boolean
  - `franquiaEventos` integer
  - `eventosIncluidos` integer
  - `eventosExcedentes` integer
  - `documentosNoCiclo` object: `eventosIncluidos + eventosExcedentes` separados em notas e eventos de nota (cancelamento, manifestação...).
    - `notas` integer
    - `eventos` integer
  - `historicoAbatidoFranquia` integer: Acordo comercial; só informativo.
  - `saldoExcedenteAberto` number: Valor em reais do excedente ainda não pago neste ciclo.
  - `limiteExcedenteAberto` number: A partir de quanto de excedente em aberto a conta é pausada automaticamente.
  - `porEmpresa` object[]
    - `empresaId` string
    - `quantidade` integer
  - `pausadaPorExcedente` boolean
  - `destravaDisponivel` boolean
  - `pacoteImportacao` object, nullable: Pacote de importação de histórico da conta, separado da franquia.

## Other responses

- `401`: Chave de API ausente, inválida ou revogada.
- `429`: 120 requisições por minuto por chave excedidas (janela fixa de 60 s, alinhada ao relógio). Sem cabeçalho `Retry-After`: espere a virada do minuto. Nas rotas de conta, empresas e documentos o corpo é este; nas de emissão, lote, webhooks e eventos é problem+json `limite_de_requisicoes`.

---

[API](https://skmtc.dev/sudrel/apis/api-publica-sudrel-nfs-e-nf-e-e-ct-e.md) · [All operations](https://skmtc.dev/sudrel/apis/api-publica-sudrel-nfs-e-nf-e-e-ct-e/llms.txt) · [OpenAPI document](https://skmtc.dev/sudrel/apis/api-publica-sudrel-nfs-e-nf-e-e-ct-e/revisions/efd7baba9e37?raw)