invoice.payment_action_required

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_VT0W44SC0TY4fekZciCupzJH",
  "created": 1676985474,
  "triggered_from": "open_api",
  "data": {
    "object": {
      "object": "invoice",
      "id": 2947349,
      "address_billing": {
        "object": "address",
        "id": 8154438,
        "city": "address cityyyy",
        "company": null,
        "country": "BT",
        "country_name": "Bhutan",
        "created_at": "2023-02-21T13:14:30.000000Z",
        "department": null,
        "first_name": "address f name",
        "is_default": true,
        "last_name": "address l name",
        "line1": "address sha5seyan",
        "line2": null,
        "postal_code": "address postal cooooode",
        "salutation": null,
        "site_ids": [
          775
        ],
        "state": "22",
        "state_name": "Dagana District",
        "title": null,
        "type": "billing",
        "updated_at": "2023-02-21T13:14:30.000000Z"
      },
      "address_shipping": {
        "object": "address",
        "id": 8154404,
        "city": "AA",
        "company": null,
        "country": "AF",
        "country_name": "Afghanistan",
        "created_at": "2023-02-20T13:55:18.000000Z",
        "department": null,
        "first_name": "Nasr City - Nozha",
        "is_default": true,
        "last_name": "A",
        "line1": "A",
        "line2": "DDD",
        "postal_code": "AA",
        "salutation": null,
        "site_ids": [
          775
        ],
        "state": "BGL",
        "state_name": "Baghlan",
        "title": null,
        "type": "shipping",
        "updated_at": "2023-02-20T13:55:18.000000Z"
      },
      "amount_due": 2400,
      "amount_paid": 0,
      "amount_remaining": 2400,
      "auto_advance": true,
      "billing": "charge_automatically",
      "billing_address": {
        "object": "address",
        "id": 8154438,
        "city": "address cityyyy",
        "company": null,
        "country": "BT",
        "country_name": "Bhutan",
        "created_at": "2023-02-21T13:14:30.000000Z",
        "department": null,
        "first_name": "address f name",
        "is_default": true,
        "last_name": "address l name",
        "line1": "address sha5seyan",
        "line2": null,
        "postal_code": "address postal cooooode",
        "salutation": null,
        "site_ids": [
          775
        ],
        "state": "22",
        "state_name": "Dagana District",
        "title": null,
        "type": "billing",
        "updated_at": "2023-02-21T13:14:30.000000Z"
      },
      "billing_reason": "subscription_create",
      "charge_id": null,
      "created": "2023-02-21T13:17:52.000000Z",
      "currency": "cad",
      "customer": {
        "object": "customer",
        "id": 8194391,
        "balance": 0,
        "created": "2023-02-20T13:44:08.000000Z",
        "currency": "cad",
        "default_source": {
          "object": "source",
          "id": 510713,
          "object_id": "src_1MdvivJSYlEHeD4bhxMTXciJ",
          "object_gateway": "stripe",
          "address_line1_check": "pass",
          "address_zip_check": "pass",
          "brand": "Visa",
          "country": "DE",
          "cvc_check": "pass",
          "dynamic_last4": null,
          "exp_month": 4,
          "exp_year": 2026,
          "funding": "credit",
          "last4": "3184",
          "name": null,
          "three_d_secure": "required",
          "tokenization_method": null,
          "site_ids": [
            775
          ]
        },
        "delinquent": false,
        "display_name": null,
        "email": "[email protected]",
        "email_confirm": null,
        "email_hardbounce": false,
        "first_name": "mail",
        "has_password": 0,
        "language": null,
        "last_login_method": null,
        "last_name": "chimp",
        "metadata": null,
        "object_id": "cus_NOMNc5o5JjBPUi",
        "organization": null,
        "password_last_updated_at": null,
        "phone": null,
        "phone_confirm": null,
        "salutation": null,
        "site_ids": [
          775
        ],
        "title": null,
        "username": null
      },
      "customer_address": {
        "city": "address cityyyy",
        "country": "BT",
        "line1": "address sha5seyan",
        "line2": null,
        "postal_code": "address postal cooooode",
        "state": "22"
      },
      "customer_shipping": null,
      "days_to_creation": 7,
      "default_tax_rates": null,
      "deleted_at": null,
      "discount_id": null,
      "ending_balance": 0,
      "finalized_at": "2023-02-21T13:17:52.000000Z",
      "hosted_invoice_url": "https://invoice.stripe.com/i/acct_1MD2qxJSYlEHeD4b/test_YWNjdF8xTUQycXhKU1lsRUhlRDRiLF9OT2pCSUxCanBZdzFKRm84N0xaM2JhdW9zUGdIS3c3LDY3NTI2Mjcz0200OtkElz6L?s=ap",
      "invoice_pdf": "https://staging.pelcro.com/pdf/invoice/eyJpdiI6IlBTYXY2UFdCb0FDUGhCQVpLaXRDYXc9PSIsInZhbHVlIjoiMVZUOVFyYnNnZldlZnRHRXY2VXNaOUt6UzYwZkRGU21ySFV3cW4yZkdNdz0iLCJtYWMiOiIyOTlhODRjN2ViYmM5NmUwM2I1YzY1ZmZiY2RlN2QwZmEzNjEyZWRiYmE1YjA3MzY1NWYwN2E4YTNlZjgwMDE4IiwidGFnIjoiIn0=",
      "is_imported": null,
      "lines": null,
      "marked_uncollectible_at": null,
      "number": null,
      "object_id": "in_1MdvjAJSYlEHeD4bEr7q9pcx",
      "paid_at": null,
      "payment_link": "https://staging.pelcro.com/invoice/payment/eyJpdiI6ImtsUjRkLzc4KzZYWnJoenJiZHFHcGc9PSIsInZhbHVlIjoiT09FQ1pUUC92K0pONURkcUZqSEN4QT09IiwibWFjIjoiNjZkNzdmNDEyYjI4Y2NhNTYyMmQ1NmY0ZTVhOTM5ZGRjNmM5MjAwZGU3NTY1YzEwNDJhNjVjNTJkYmEyYjJkNCIsInRhZyI6IiJ9",
      "period_end": "2023-02-21T13:17:51.000000Z",
      "period_start": "2023-02-21T13:17:51.000000Z",
      "plan": {
        "id": 374945,
        "nickname": "CAD_Weekly_Auto_regular_time_withPhases",
        "interval": "week"
      },
      "post_payment_credit_notes_amount": 0,
      "pre_payment_credit_notes_amount": 0,
      "product": {
        "id": 4900,
        "name": "Upcoming",
        "name_internal": null
      },
      "purchase_order": null,
      "site_id": 775,
      "source": {
        "object": "source",
        "id": 510713,
        "object_id": "src_1MdvivJSYlEHeD4bhxMTXciJ",
        "object_gateway": "stripe",
        "address_line1_check": "pass",
        "address_zip_check": "pass",
        "brand": "Visa",
        "country": "DE",
        "cvc_check": "pass",
        "dynamic_last4": null,
        "exp_month": 4,
        "exp_year": 2026,
        "funding": "credit",
        "last4": "3184",
        "name": null,
        "three_d_secure": "required",
        "tokenization_method": null,
        "site_ids": [
          775
        ]
      },
      "starting_balance": 0,
      "status": "open",
      "subscription": {
        "object": "subscription",
        "id": 2896260,
        "billing": "charge_automatically",
        "cancel_at_period_end": 0,
        "canceled_at": null,
        "created": "2023-02-21T13:17:51.000000Z",
        "current_period_start": "2023-02-21T13:17:51.000000Z",
        "current_period_end": "2023-02-28T13:17:51.000000Z",
        "schedules": null,
        "plan": {
          "id": 374945,
          "product_id": 4900,
          "parent_plan_id": null,
          "object_id": "plan_NCLDG4YGNZp5kb",
          "active": "active",
          "type": "regular",
          "amount": 2400,
          "recognized_revenue_type": "time",
          "renewal_strategy": null,
          "auto_renew": true,
          "available_online": true,
          "allow_send_invoice": false,
          "auto_uncollectible_days": null,
          "invoice_upcoming_notification": null,
          "currency": "cad",
          "countries": null,
          "entitlements": null,
          "interval": "week",
          "interval_count": 1,
          "is_imported": false,
          "is_hidden": false,
          "is_donation": false,
          "metadata": null,
          "member_seat_capacity": null,
          "nickname": "CAD_Weekly_Auto_regular_time_withPhases",
          "name_internal": null,
          "refundable": true,
          "shipments_per_interval": null,
          "description": null,
          "trial_period_days": 0,
          "ip_addresses": null,
          "domains": null,
          "created_at": "2023-01-19T11:43:53.000000Z",
          "updated_at": "2023-01-19T11:43:54.000000Z",
          "site_ids": [
            775,
            791
          ],
          "product": {
            "id": 4900,
            "object_id": "prod_NCKiNHJ2jiUGmQ",
            "type": "service",
            "active": "active",
            "address_required": true,
            "countries": null,
            "description": null,
            "entitlements": [
              "entp_1"
            ],
            "is_imported": null,
            "is_hidden": null,
            "language": null,
            "livemode": false,
            "metadata": null,
            "name": "Upcoming",
            "name_internal": null,
            "shippable": null,
            "statement_descriptor": null,
            "created_at": "2023-01-19T11:12:44.000000Z",
            "updated_at": "2023-02-10T14:15:29.000000Z",
            "site_ids": [
              775,
              791
            ]
          }
        }
      },
      "subscription_id": 2896260,
      "subtotal": 2400,
      "tax": null,
      "tax_percent": null,
      "total": 2400,
      "total_tax_amounts": null,
      "updated_at": "2023-02-21T13:17:54.000000Z",
      "voided_at": null
    }
  }
}