Skip to main content

Migração de Plano

Este fluxo descreve a solicitação de migração de plano de um contrato, iniciada pelo nosso sistema, e a respectiva confirmação por webhook enviada pelo sistema do parceiro.

🔁 Visão Geral do Fluxo​

  1. Nosso sistema envia uma requisição para a API do parceiro solicitando a migração de plano.
  2. A API do parceiro processa a solicitação.
  3. Após o processamento, o parceiro envia o webhook MIGRATE_PLAN para confirmar a migração.

📤 Requisição enviada pelo nosso sistema (para o parceiro)​

Endpoint (API do parceiro): definido pelo parceiro.

Payload:

{
  "contract_id": 123,
  "partner_pay_subscription_id": 456,
  "event": "MIGRATE_PLAN",
  "data": {
    "plan_subscription_id": 789,
    "companie_user_id": 1011
  }
}

✅ Regras da solicitação​

  • O plan_subscription_id deve estar ativo no nosso sistema.
  • A migração deve ser possível para o contrato atual.

📥 Webhook de retorno esperado​

Após processar a alteração, a API do parceiro deve nos enviar o webhook MIGRATE_PLAN.

🔗 Veja a documentação do webhook MIGRATE_PLAN

📋 Exemplo do fluxo completo​

🧪 Considerações técnicas​

  • A requisição pode ser assíncrona: a resposta da API do parceiro não confirma o sucesso, apenas o webhook.
  • O parceiro deve garantir retentativas caso o webhook falhe.

🔄 Resposta esperada do webhook​

{
  "success": true
}