API Reference
Start typing to search…

Subscription

Eventos

Contexto subscription

NomeDescrição
subscription.createdEnviado quando uma assinatura é criada.
subscription.updatedEnviado quando uma assinatura é atualizada.
subscription.cancelledEnviado quando uma assinatura é removida.

Exemplo

{
  "context": "subscription",
  "event": "subscription.created",
  "establishment": "4e0ec338-b344-4dba-92d7-5cf4923408bc",
  "timestamp": "2024-09-13T12:32:50.565Z",
  "version": "1",
  "data":{
      id_subscription: "sub_2nZz0JyCYFXGOVboITz0efKS7b0",
      id_plan: "pln_2nZyKYKrjfBWAXGxHlYNkmVRZfg",
      id_merchant: "mer_91d41c46c40448",
      id_card: null,
      status: "active",
      charge_type: "pix",
      charge_day: 4,
      external_reference_id: null,
      start_date: "2024-09-19T12:23:34.490535Z",
      end_date: null,
      cycles: null,
      cycles_done: null,
      total_amount_charges: 0,
      total_quantity_charges: 0,
      customer_name: "Jaime Junior",
      customer_document: 12483246761,
      customer_ip: "172.16.15.23",
      customer_email: "[email protected]",
      product_description: "Pagamento semanal",
      created_at: "2024-10-23T12:23:34.490535Z",
      updated_at: "2024-10-23T12:23:34.490535Z",
    },
}

{
  "context": "subscription",
  "event": "subscription.updated",
  "establishment": "4e0ec338-b344-4dba-92d7-5cf4923408bc",
  "timestamp": "2024-09-13T12:32:50.565Z",
  "version": "1",
  "data":{
      id_subscription: "sub_2nZz0JyCYFXGOVboITz0efKS7b0",
      id_plan: "pln_2nZyKYKrjfBWAXGxHlYNkmVRZfg",
      id_merchant: "mer_91d41c46c40448",
      id_card: null,
      status: "active",
      charge_type: "pix",
      charge_day: 4,
      external_reference_id: null,
      start_date: "2024-09-19T12:23:34.490535Z",
      end_date: null,
      cycles: null,
      cycles_done: null,
      total_amount_charges: 0,
      total_quantity_charges: 0,
      customer_name: "Jaime Junior",
      customer_document: 12483246761,
      customer_ip: "172.16.15.23",
      customer_email: "[email protected]",
      product_description: "Pagamento semanal",
      created_at: "2024-10-23T12:23:34.490535Z",
      updated_at: "2024-10-23T12:23:34.490535Z",
    },
}

{
  "context": "subscription",
  "event": "subscription.cancelled",
  "establishment": "4e0ec338-b344-4dba-92d7-5cf4923408bc",
  "timestamp": "2024-09-13T12:32:50.565Z",
  "version": "1",
  "data":{
      id_subscription: "sub_2nZz0JyCYFXGOVboITz0efKS7b0",
      id_plan: "pln_2nZyKYKrjfBWAXGxHlYNkmVRZfg",
      id_merchant: "mer_91d41c46c40448",
      id_card: null,
      status: "active",
      charge_type: "pix",
      charge_day: 4,
      external_reference_id: null,
      start_date: "2024-09-19T12:23:34.490535Z",
      end_date: null,
      cycles: null,
      cycles_done: null,
      total_amount_charges: 0,
      total_quantity_charges: 0,
      customer_name: "Jaime Junior",
      customer_document: 12483246761,
      customer_ip: "172.16.15.23",
      customer_email: "[email protected]",
      product_description: "Pagamento semanal",
      created_at: "2024-10-23T12:23:34.490535Z",
      updated_at: "2024-10-23T12:23:34.490535Z",
    },
}