Skip to main content

​
invoice.created

Disparado quando uma nova fatura de assinatura é gerada. Ocorre automaticamente a cada ciclo da assinatura.
Payload
{
  "type": "invoice.created",
  "id": "hook_f6a1b2c3d4e5",
  "data": {
    "code": "ord_invoice123",
    "status": "Pending",
    "value": 99.90,
    "payment_type": "CreditCard",
    "subscription_code": "sub_abc123xyz",
    "due_date": "2026-06-01T00:00:00.000000Z",
    "created_at": "2026-05-27T00:00:00.000000Z"
  }
}
CampoTipoDescrição
codestringCódigo único do pedido desta fatura
statusstringStatus inicial (Pending ou Approved)
valuedecimalValor da fatura em reais
payment_typestringMétodo de pagamento da assinatura
subscription_codestringCódigo da assinatura relacionada
due_datestringData de vencimento da fatura (ISO 8601)
created_atstringData de geração da fatura (ISO 8601)

​
invoice.failed

Disparado quando a tentativa de cobrança de uma fatura de assinatura falha — normalmente por recusa do cartão ou saldo insuficiente.
Payload
{
  "type": "invoice.failed",
  "id": "hook_a1b2c3d4e5f6",
  "data": {
    "code": "ord_invoice456",
    "status": "Failed",
    "value": 99.90,
    "payment_type": "CreditCard",
    "subscription_code": "sub_abc123xyz",
    "failure_reason": "card_declined",
    "failed_at": "2026-05-27T10:00:00.000000Z"
  }
}
CampoTipoDescrição
codestringCódigo único do pedido desta fatura
statusstringSempre Failed
valuedecimalValor da fatura em reais
payment_typestringMétodo de pagamento da assinatura
subscription_codestringCódigo da assinatura relacionada
failure_reasonstringMotivo da falha retornado pelo gateway
failed_atstringData/hora da falha (ISO 8601)
Após uma falha de fatura, a assinatura pode entrar no status RecurringOverdue. Use o endpoint Quitar fatura em atraso para permitir que o cliente regularize manualmente.