invoice.payment_action

The invoice.payment_action_required event gets triggered when an invoice payment attempt requires further end-user action to complete. In this case, the invoice will remain in open status until paid.

{
  "type": "invoice.payment_action_required",
  "id": "evt_rhquiJ9QiImp6stzvFksBA1n",
  "created": 1663940968,
  "data": {
    "object": {
      "object": "invoice",
      "id": null,
      "address_billing": null,
      "address_shipping": null,
      "amount_due": 1000,
      "amount_paid": 0,
      "amount_remaining": 1000,
      "auto_advance": true,
      "billing": "charge_automatically",
      "billing_address": null,
      "billing_reason": "manual",
      "created": "2022-09-23T13:49:23.000000Z",
      "currency": "cad",
      "customer": {
        "object": "customer",
        "id": 49,
        "balance": 0,
        "created": "2022-09-23T13:34:46.000000Z",
        "currency": null,
        "default_source": null,
        "delinquent": false,
        "display_name": null,
        "email": "[email protected]",
        "email_confirm": null,
        "first_name": null,
        "has_password": 1,
        "language": "en",
        "last_name": null,
        "metadata": null,
        "object_id": "cus_LfuIniIMswP65V",
        "password_last_updated_at": null,
        "phone": null,
        "phone_confirm": null,
        "salutation": null,
        "title": null
      },
      "customer_address": null,
      "customer_shipping": null,
      "default_tax_rates": null,
      "ending_balance": null,
      "hosted_invoice_url": null,
      "invoice_pdf": null,
      "lines": null,
      "number": null,
      "object_id": "in_1LlCFrF6T5bzNO3zuuxY18ZZ",
      "paid_at": null,
      "period_end": "2022-09-23T13:49:22.000000Z",
      "period_start": "2022-09-23T13:49:22.000000Z",
      "post_payment_credit_notes_amount": 0,
      "pre_payment_credit_notes_amount": 0,
      "source": null,
      "starting_balance": 0,
      "status": "open",
      "subtotal": 1000,
      "tax": null,
      "tax_percent": null,
      "total": 1000,
      "total_tax_amounts": null
    }
  }
}