Consultar status da assinatura de um plano

GET

/v2/plans/{code}/status

Retorna a situação da assinatura de um plano para a empresa do usuário autenticado: se é período de testes (trial), se está ativa, se a renovação automática está ligada, a data de validade e se já venceu. A empresa é a do token; não é possível consultar outra empresa por esta rota. Se a empresa nunca assinou nem testou o plano, a resposta vem com trial, active, renovate e expired iguais a false e sem expiresIn. A validade é comparada com o início do dia (00:00) de expiresIn: no próprio dia do vencimento, expired já vem true. Enquanto a validade não chega, active vem true. Requer autenticação via Bearer JWT ou header x-api-key.

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

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Sucesso

{
    "trial": false,
    "active": true,
    "renovate": true,
    "expiresIn": "2026-10-25T03:00:00.000Z",
    "expired": false
}

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

Página anterior

Visualizar relatório personalizado de um cliente

Próxima página

Assinar plano ou iniciar período de testes