Conta

Consumo do ciclo de cobrança atual

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.

get/v1/usage

Request

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

Response

OK

temCicloAtivoboolean
planoMinimoRecebidasobject nullable

Se a conta precisa de um plano maior pelo número de CNPJs monitorados.

franquiaEventosinteger
eventosIncluidosinteger
eventosExcedentesinteger
historicoAbatidoFranquiainteger

Acordo comercial; só informativo.

saldoExcedenteAbertonumber

Valor em reais do excedente ainda não pago neste ciclo.

limiteExcedenteAbertonumber

A partir de quanto de excedente em aberto a conta é pausada automaticamente.

pausadaPorExcedenteboolean
destravaDisponivelboolean
pacoteImportacaoobject nullable

Pacote de importação de histórico da conta, separado da franquia.

Changes

No recorded changes to this operation across all 1 revision of this API.