Eventos · Assinaturas

Assinaturas

Ciclo de vida de assinaturas criadas via checkout de assinatura no dashboard. Use para liberar plano, suspender acesso e contabilidade.

No primeiro pagamento, disparamos payment.paid, checkout.completed e subscription.activated. Prefira subscription.activated para liberar o plano recorrente.

Eventos

EventoQuandoUso
subscription.createdCheckout de assinatura + registro pendentePré-cadastro no seu CRM
subscription.activatedPrimeiro pagamento confirmadoLiberar plano / acesso
subscription.canceledAssinatura canceladaRevogar acesso
subscription.past_dueRenovação pendente ou falhaCobrança / dunning

Objeto subscription

CampoTipoDescrição
idstringUUID da assinatura
codestringCódigo sub_…
statusstringpending | active | past_due | canceled
amount_centsnumberValor em centavos
payment_methodstring | nullpix, card…
checkout_idstring | nullCheckout de origem
customerobjectid, name, email
payment_idstring | nullPedido que ativou (activated)

Exemplo de payload

{
  "id": "evt_…",
  "type": "subscription.activated",
  "api_version": "v2",
  "created": 1710000000,
  "created_at": "2026-03-09T12:00:00.000Z",
  "livemode": true,
  "data": {
    "object": {
      "id": "uuid-assinatura",
      "code": "sub_…",
      "status": "active",
      "amount_cents": 4990,
      "amount_label": "R$ 49,90",
      "currency": "BRL",
      "payment_method": "pix",
      "checkout_id": "uuid-checkout",
      "customer": {
        "id": "uuid-cliente",
        "name": "Maria Silva",
        "email": "maria@email.com"
      },
      "created_at": "…",
      "updated_at": "…",
      "payment_id": "uuid-pedido"
    }
  },
  "source": "hyzepay"
}

Fluxo recomendado

  1. Merchant cria checkout de assinatura → subscription.created
  2. Cliente paga no /pay
  3. HyzePay confirma PIX → subscription.activated + payment.paid
  4. Seu backend libera o plano com idempotência por event.id