Registra um Plano Anual
Planos Anuais
Registra um Plano Anual
Contrata uma proteção anual com pagamento único para o dispositivo do cliente
POST
Registra um Plano Anual
string
required
Token de autenticação do tipo Bearer obtido através do endpoint de login.
string
required
Deve ser definido como
application/json.string
required
Deve ser definido como
application/json.integer
required
ID do modelo do dispositivo a ser protegido. Obtido via
GET /models. O modelo deve estar ativo e não listado como indisponível.integer
required
ID do cliente (segurado). Obtido via
POST /customers ou GET /customers/{document}.integer
required
ID do plano de proteção (apólice). Vinculado ao parceiro autenticado — verificar quais estão disponíveis com o suporte ClubFix.
string
required
IMEI principal do dispositivo. Deve ser diferente de
imei_2 quando ambos forem informados.string
Segundo IMEI para aparelhos dual-SIM. Opcional. Deve ser diferente de
imei.boolean
Indica se o dispositivo possui mais de 3 meses de uso.
true ou false. Padrão: false.integer
ID de uma sub-loja vinculada ao parceiro. Opcional — permite atribuir a venda a uma filial. Obtido via
GET /shopkeepers.number
Valor do LMI (Limite Máximo de Indenização) desejado. Validado contra a faixa autorizada do parceiro — se fora da faixa, usa o padrão do modelo sem gerar erro.
object
Dados de pagamento. Obrigatório para parceiros com gateway externo. Ignorado para parceiros com gateway ClubFix (o pagamento é processado via
POST /annual-plans/{id}/payment).string
Método de pagamento. Valores:
credit_card, slip, pix. Obrigatório quando payment for informado.integer
Número de parcelas para pagamento no cartão de crédito. Inteiro entre
1 e 12. Obrigatório quando payment.method for credit_card.Resposta
Retorna o recurso do Plano Anual criado.Para parceiros com gateway ClubFix: após criar o plano, chame
POST /annual-plans/{id}/payment para processar o pagamento.Para parceiros com gateway externo: realize a cobrança no seu sistema e chame POST /annual-plans/{id}/notify-payment para ativar o plano.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
200
Success
