Listar planos assinados por uma empresa

GET

/v2/plans/{companyId}

Rota administrativa. Lista todas as assinaturas de planos da empresa informada, em teste ou contratadas, vigentes ou vencidas: nome e código do plano, se está ativa, se a renovação automática está ligada, quem assinou (nome e e-mail), a data da contratação, a data de início do período de testes e a data de validade (AAAA-MM-DD). Aqui, active é calculado pela validade: true enquanto a data de validade não chegou. A data da contratação só vem para planos contratados, não para períodos de teste. Empresa sem assinaturas devolve plans vazio. Requer autenticação via Bearer JWT ou header x-api-key, mas isso não basta: exige usuário com permissão de administrador. Usuário sem perfil de permissão recebe 403 (Acesso negado); perfil sem acesso de administrador, 401 (Permissão inválida!); usuário inativo, 404 (Usuário não encontrado).

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200

application/json

Harvested 200

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠403Acesso negado

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/plans/' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "plans": [
        {
            "name": "Radar RJ",
            "code": "radar-rj",
            "active": true,
            "renovate": true,
            "signedByUser": {
                "name": "Maria Souza",
                "email": "maria.souza@empresa.com.br"
            },
            "signedAt": "2026-08-25T14:02:31.118Z",
            "trialAt": "2026-08-10T17:06:11.216Z",
            "expiresIn": "2026-10-24"
        }
    ]
}

Modificado em 2026-10-13 09:47:06

Página anterior

Assinar plano ou iniciar período de testes

Próxima página

Listar ocorrências do Radar RJ