SuperSign - API Oficial
  1. Conta
  • SuperSign API Pública
    • Introdução
      • Primeiro envelope em 5 minutos
      • Integrar com IA
      • Testar a API no Postman
      • Paginação e filtros
      • Catálogo de erros
      • Receitas em Node.js, PHP e Python
      • Changelog
      • Idempotência e erros
      • Estados do envelope
      • Webhooks
      • Limites de requisição
      • Criar um envelope a partir de um modelo
    • Referência da API
      • Conta
        • Consultar a conta da integração
          GET
        • Consultar capacidades da integração
          GET
        • Consultar o catálogo de capacidades
          GET
        • Listar chamadas da própria chave
          GET
        • Consultar consumo do ciclo
          GET
        • Validar a chave de API
          GET
      • Envelopes
        • Excluir rascunho de envelope
        • Consultar histórico do envelope
        • Criar e enviar envelope numa chamada
        • Gerar URL de download do envelope em ZIP
        • Duplicar envelope
        • Criar rascunho de envelope
        • Listar envelopes
        • Atualizar configurações do envelope
        • Enviar envelope
        • Consultar envelope
        • Mover envelope para outra pasta
        • Anular envelope
      • Participantes
        • Listar participantes do envelope
        • Aprovar participante aprovador
        • Recusar como participante aprovador
        • Corrigir contato do participante
        • Sincronizar participantes
        • Enviar lembrete ao participante
      • Documentos
        • Listar documentos do envelope
        • Substituir campos do documento
        • Listar campos do documento
        • Confirmar o PDF convertido de um DOCX
        • Validar um documento selado
        • Reordenar documentos do envelope
        • Adicionar documento ao envelope
        • Gerar URL de download do documento
      • Contatos
        • Atualizar contato parcialmente
        • Listar envelopes do contato
        • Listar listas de contatos
        • Consultar lista de contatos
        • Criar contato
        • Listar contatos
        • Consultar contato
        • Atualizar contato
        • Excluir contato
      • Equipe
        • Listar grupos da conta
        • Listar membros da conta
      • Pastas
        • Listar conteúdo da pasta
        • Consultar acesso da pasta
        • Excluir pasta
        • Renomear pasta
        • Mover pasta
        • Listar todas as pastas
        • Criar pasta
      • Convites
        • Listar convites da conta
      • Webhooks
        • Excluir webhook
        • Listar entregas de um webhook
        • Detalhar uma entrega de webhook
        • Reenviar uma entrega de webhook
        • Girar o segredo de assinatura do webhook
        • Criar webhook
        • Listar webhooks
        • Atualizar webhook
      • Modelos
        • Listar modelos
        • Consultar modelo
        • Criar envelope a partir de modelo
        • Criar modelo em rascunho
        • Editar título e descrição do modelo
        • Consultar processamento do documento do modelo
        • Ativar modelo
        • Duplicar modelo
        • Enviar documentos do modelo
        • Definir vagas do modelo
        • Posicionar campos no documento do modelo
      • Auditoria e relatórios
        • Listar envelopes anulados
        • Relatório de envelopes
        • Relatório de uso por grupo
      • Etiquetas
        • Aplicar etiqueta ao envelope
        • Remover etiqueta do envelope
        • Listar etiquetas da conta
  1. Conta

Consultar consumo do ciclo

Sandbox
Sandbox
GET
/v4/api/account/usage
Devolve o consumo de envelopes da conta no ciclo de cobrança vigente: enviados, concluídos, cota, quanto resta e o percentual usado. É a mesma cota que o limite de envio aplica, já com o ajuste contratado da conta. Os números são da conta inteira e não dependem do usuário responsável pela chave.

Requisição

Nenhum

Respostas

🟢200OK
application/json
Sucesso
Headers

Bodyapplication/json

🟠401Não Autorizado
🟠403Proibido
🟠404Registo Não Encontrado
🟠429
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/v4/api/account/usage'
Response Response Example
200 - Exemplo 1
{
    "cycle": {
        "startDate": "2019-08-24T14:15:22.123Z",
        "endDate": "2019-08-24T14:15:22.123Z"
    },
    "envelopes": {
        "sent": 0,
        "completed": 0,
        "quota": 0,
        "remaining": 0,
        "usagePercentage": 0,
        "unlimited": true
    }
}
Modificado em 2026-09-29 13:39:12
Página anterior
Listar chamadas da própria chave
Próxima página
Validar a chave de API
Built with