Informacoes do Plano

Retorna as informacoes do plano ativo da conta autenticada, incluindo limites de uso e periodo de cobranca.

Requisicao

GET /v1/subscriptions/me/active

Headers

Header	Tipo	Obrigatorio	Descricao
Authorization	string	Sim	Bearer token de autenticacao

Parametros

Nenhum parametro necessario.

Exemplo de requisicao

curl -X GET \
  https://api.tapsign.com.br/v1/subscriptions/me/active \
  -H "Authorization: Bearer {token}"

Resposta

200 - Sucesso

{
  "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "name": "Profissional",
  "status": "ACTIVE",
  "billingInterval": "MONTHLY",
  "currentPeriodStart": "2026-03-01T00:00:00Z",
  "currentPeriodEnd": "2026-04-01T00:00:00Z",
  "limits": {
    "maxDocuments": 100,
    "maxSignatures": 300,
    "maxTemplates": 20
  },
  "usage": {
    "documentsUsed": 42,
    "signaturesUsed": 87,
    "templatesUsed": 5
  },
  "createdAt": "2025-11-15T10:30:00Z"
}

Campos da resposta

Campo	Tipo	Descricao
id	string	Identificador unico da assinatura do plano
name	string	Nome do plano (Gratuito, Profissional, Equipe, Enterprise)
status	string	Status da assinatura (ACTIVE, PAST_DUE, CANCELED, TRIALING)
billingInterval	string	Intervalo de cobranca (MONTHLY, YEARLY)
currentPeriodStart	string	Inicio do periodo atual (ISO 8601)
currentPeriodEnd	string	Fim do periodo atual (ISO 8601)
limits.maxDocuments	number	Limite de documentos por periodo
limits.maxSignatures	number	Limite de assinaturas por periodo
limits.maxTemplates	number	Limite de modelos
usage.documentsUsed	number	Documentos utilizados no periodo atual
usage.signaturesUsed	number	Assinaturas utilizadas no periodo atual
usage.templatesUsed	number	Modelos criados
createdAt	string	Data de criacao da assinatura (ISO 8601)

Dica

Use este endpoint para exibir o consumo do plano no dashboard e alertar o usuario quando estiver proximo dos limites.

401 - Nao autorizado

{
  "error": "UNAUTHORIZED",
  "message": "Token de autenticacao invalido ou expirado."
}

404 - Plano nao encontrado

{
  "error": "NOT_FOUND",
  "message": "Nenhuma assinatura ativa encontrada para esta conta."
}

Atencao

Se a conta nao possui um plano ativo (ex: periodo de teste expirado sem conversao), este endpoint retornara 404.