Assinar plano ou iniciar período de testes

POST

/v2/plans/{code}/sign

Contrata um plano de assinatura, ou inicia o período de testes dele, para a empresa do usuário autenticado. Com type = "sign", o preço do plano é debitado dos créditos da empresa e a assinatura fica ativa, com renovação automática, pelo período do plano. Com qualquer outro valor de type, é iniciado o período de testes, sem cobrança, pela duração de testes do plano; isso só acontece se a empresa ainda não tiver assinatura desse plano. Se a assinatura existe, está ativa e teve a renovação automática cancelada, a chamada religa a renovação sem nova cobrança. Assinatura ativa com renovação ligada é recusada com erro. A cobrança e a gravação da assinatura acontecem na mesma transação: se uma falhar, nada é gravado. 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

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200

application/json

Inferred 200 (from source code)

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠404Plano não encontrado

🟠400Falha na assinatura do plano

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/plans//sign' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "type": "sign"
}'

Response Example

200 - Contratado

{
    "message": "Módulo Radar RJ contratado com sucesso."
}

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

Página anterior

Consultar status da assinatura de um plano

Próxima página

Listar planos assinados por uma empresa