Assinatura

Este Webhook notificará qualquer evento de Assinatura, seja quando uma nova assinatura é criada ou quando tem seu status ou número de cobranças alterado.

{
  "user": {
    "id": "12507",
    "name": "Fabio Godoy",
    "email": "[email protected]",
    "phone": "(14) 91234-5678"
  },
  "subscription": {
    "id": "34",
    "status": 1,
    "charged_times": 0,
    "recurrency": 1,
    "lifetime": 1,
    "renewal": "2023-01-24",
    "price": 4,
    "coupon": null,
    "coupon_lifetime": 0,
    "coupon_charges": 0,
    "installments": 0,
    "cycle": 2,
    "max_charges": 1,
    "trial": 1,
    "dates": {
      "start": "2023-01-24 14:40:53",
      "last_charge": "2023-01-24",
      "next_charge": "2023-02-24",
      "canceled": null,
      "reactivation": null,
      "trial_started": "2023-01-24 14:40:53",
      "trial_finished": null
    }
  },
  "product": {
    "id": "83",
    "name": "Assinatura Teste",
    "offer": {
      "id": "74",
      "name": "Oferta Plano - 83",
      "price": "3.00"
    }
  },
  "webhook": {
    "id": 9,
    "type": 8,
    "queue_id": 100
  },
  "token": "123456789"
}

🚧

Mas como consigo habilitar o uso desse Webhook?

Esse json de dados é enviado para todos os webhooks do tipo Assinatura cadastrados. Então basta cadastrar uma URL de webhook e aguardar esse retorno para fazer o tratamento dos dados!

📘

Retornos do json

user
id: ID do usuário

product
id: ID do produto

product->offer
id: ID da oferta

enrollment
id: ID da matrícula

subscription
id: ID da assinatura
charged_times: Vezes que a assinatura já foi cobrada
max_charges: Limite de cobranças definido
coupon_charges: Cobranças com cupom aplicado
installments: Parcelamento da cobrança

subscription->coupon_lifetime
0 = Não vitalício
1 = Vitalício em todas as cobranças

subscription->cycles
1 - Mensal
2 - Trimestral
3 - Semestral
4 - Anual
5 - Semanal
6 - Quinzenal
7 - Bienal
8 - Trienal

subscription->status
0 = Cancelada
1 = Ativa
2 = Aguardando
3 = Em teste
4 = Expirada
5 = Concluída
6 = Bloqueada

subscription->automatic_renewal
0 = Não renova automaticamente
1 = Renova automaticamente após o fim de cada ciclo

subscription->lifetime
0 = Não vitalício
1 = Vitalício

subscription->trial
0 = Não permitiu teste
1 = Permitiu teste antes de iniciar a assinatura

subscription->dates
start: Data que o aluno iniciou a assinatura
next_charge: Data da próxima cobrança
renewal: Data da próxima renovação de ciclo
canceled: Data que a assinatura foi cancelada
reactivation: Data que a assiantura foi reativada
trial_started: Data que iniciou o período de testes do plano
trial_finished: Data que temrinou o período de testes

webhook
id: ID do cadastro do endpoint
type: 8 = Assinatura
queue_id: ID da fila de notificações do webhook