API Reference
Start typing to search…

Invoice

Eventos

Contexto invoice

NomeDescrição
invoice.createdEnviado quando uma fatura é criada.
invoice.openedEnviado quando uma fatura é aberta.
invoice.duedatedEnviado quando uma fatura está devida.
invoice.paidEnviado quando uma fatura é paga.
invoice.cancelledEnviado quando uma fatura é cancelada.
invoice.charge.pixEnviado quando uma fatura do tipo pix vai ser cobrada.

Exemplo

{
  "context": "invoice",
  "event": "invoice.created",
  "establishment": "4e0ec338-b344-4dba-92d7-5cf4923408bc",
  "timestamp": "2024-09-13T12:32:50.565Z",
  "version": "1",
  "data": {
      id_invoice: "inv_2nLIouEoLpxIJHlDpvDobUKgKpu",
      id_plan: "pln_2nLH0u4xNxswVI9yeJlqwAmBsxh",
      id_subscription: "sub_2nLIow20qn8M0YUPteFRWwKiOsC",
      id_card: "crd_2nJHqeFqJKWwqZBSRf53wM72RXG",
      status: EnumInvoiceStatus.OPEN,
      reference_date: "2024-10-12T00:00:00Z",
      charge_intent: 0,
      amount: 15000,
      currency: EnumCurrency.BRL,
      created_at: "2024-10-12T15:15:07.152962Z",
      updated_at: "2024-10-12T15:15:07.165507Z",
  },
}
{
  "context": "invoice",
  "event": "invoice.opened",
  "establishment": "4e0ec338-b344-4dba-92d7-5cf4923408bc",
  "timestamp": "2024-09-13T12:32:50.565Z",
  "version": "1",
  "data": {
      id_invoice: "inv_2nLIouEoLpxIJHlDpvDobUKgKpu",
      id_plan: "pln_2nLH0u4xNxswVI9yeJlqwAmBsxh",
      id_subscription: "sub_2nLIow20qn8M0YUPteFRWwKiOsC",
      id_card: "crd_2nJHqeFqJKWwqZBSRf53wM72RXG",
      status: EnumInvoiceStatus.OPEN,
      reference_date: "2024-10-12T00:00:00Z",
      charge_intent: 0,
      amount: 15000,
      currency: EnumCurrency.BRL,
      created_at: "2024-10-12T15:15:07.152962Z",
      updated_at: "2024-10-12T15:15:07.165507Z",
  },
}
{
  "context": "invoice",
  "event": "invoice.duedated",
  "establishment": "4e0ec338-b344-4dba-92d7-5cf4923408bc",
  "timestamp": "2024-09-13T12:32:50.565Z",
  "version": "1",
  "data": {
      id_invoice: "inv_2nLIouEoLpxIJHlDpvDobUKgKpu",
      id_plan: "pln_2nLH0u4xNxswVI9yeJlqwAmBsxh",
      id_subscription: "sub_2nLIow20qn8M0YUPteFRWwKiOsC",
      id_card: "crd_2nJHqeFqJKWwqZBSRf53wM72RXG",
      status: EnumInvoiceStatus.OPEN,
      reference_date: "2024-10-12T00:00:00Z",
      charge_intent: 0,
      amount: 15000,
      currency: EnumCurrency.BRL,
      created_at: "2024-10-12T15:15:07.152962Z",
      updated_at: "2024-10-12T15:15:07.165507Z",
  },
}
{
  "context": "invoice",
  "event": "invoice.paid",
  "establishment": "4e0ec338-b344-4dba-92d7-5cf4923408bc",
  "timestamp": "2024-09-13T12:32:50.565Z",
  "version": "1",
  "data": {
      id_invoice: "inv_2nLIouEoLpxIJHlDpvDobUKgKpu",
      id_plan: "pln_2nLH0u4xNxswVI9yeJlqwAmBsxh",
      id_subscription: "sub_2nLIow20qn8M0YUPteFRWwKiOsC",
      id_card: "crd_2nJHqeFqJKWwqZBSRf53wM72RXG",
      status: EnumInvoiceStatus.OPEN,
      reference_date: "2024-10-12T00:00:00Z",
      charge_intent: 0,
      amount: 15000,
      currency: EnumCurrency.BRL,
      created_at: "2024-10-12T15:15:07.152962Z",
      updated_at: "2024-10-12T15:15:07.165507Z",
  },
}
{
  "context": "invoice",
  "event": "invoice.cancelled",
  "establishment": "4e0ec338-b344-4dba-92d7-5cf4923408bc",
  "timestamp": "2024-09-13T12:32:50.565Z",
  "version": "1",
  "data": {
      id_invoice: "inv_2nLIouEoLpxIJHlDpvDobUKgKpu",
      id_plan: "pln_2nLH0u4xNxswVI9yeJlqwAmBsxh",
      id_subscription: "sub_2nLIow20qn8M0YUPteFRWwKiOsC",
      id_card: "crd_2nJHqeFqJKWwqZBSRf53wM72RXG",
      status: EnumInvoiceStatus.OPEN,
      reference_date: "2024-10-12T00:00:00Z",
      charge_intent: 0,
      amount: 15000,
      currency: EnumCurrency.BRL,
      created_at: "2024-10-12T15:15:07.152962Z",
      updated_at: "2024-10-12T15:15:07.165507Z",
  },
}
{
  "context": "invoice",
  "event": "invoice.charge.pix",
  "establishment": "4e0ec338-b344-4dba-92d7-5cf4923408bc",
  "timestamp": "2024-09-13T12:32:50.565Z",
  "version": "1",
  "data": {
      "id_invoice": "inv_2nLIouEoLpxIJHlDpvDobUKgKpu",
      "id_plan": "pln_2nLH0u4xNxswVI9yeJlqwAmBsxh",
      "id_subscription": "sub_2nLIow20qn8M0YUPteFRWwKiOsC",
      "id_card": null,
      "status": "open",
      "reference_date": "2024-10-12T00:00:00Z",
      "charge_intent": 0,
      "amount": 15000,
      "currency": "BRL",
      "created_at": "2024-10-12T15:15:07.152962Z",
      "updated_at": "2024-10-12T15:15:07.165507Z"
  }
}