invoice.payment_succeeded

The invoice.payment_succeeded event gets triggered when the invoice status changes to Paid, or that any attempt to pay an invoice is successful.

{
  "type": "invoice.payment_succeeded",
  "id": "evt_wXweAm56Iaru06egY7Y7ZerQ",
  "created": 1676985105,
  "triggered_from": "open_api",
  "data": {
    "object": {
      "object": "invoice",
      "id": 2947310,
      "address_billing": null,
      "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": 0,
      "amount_paid": 3500,
      "amount_remaining": 0,
      "auto_advance": true,
      "billing": "send_invoice",
      "billing_address": null,
      "billing_reason": "subscription_create",
      "charge": {
        "id": 1731973,
        "offline": true,
        "payment_category": "Wire",
        "reference": "ayman"
      },
      "charge_id": 1731973,
      "created": "2023-02-21T13:06:47.000000Z",
      "currency": "cad",
      "customer": {
        "object": "customer",
        "id": 8194391,
        "balance": 0,
        "created": "2023-02-20T13:44:08.000000Z",
        "currency": "cad",
        "default_source": null,
        "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": null,
      "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:06:47.000000Z",
      "hosted_invoice_url": "https://invoice.stripe.com/i/acct_1MD2qxJSYlEHeD4b/test_YWNjdF8xTUQycXhKU1lsRUhlRDRiLF9OT2owak5tSnFydFEzNUkyTnE5ZEF0NTNHUHB4cFFLLDY3NTI1ODk10200nT7aBa7x?s=ap",
      "invoice_pdf": "https://staging.pelcro.com/pdf/invoice/eyJpdiI6IlhKclpDUGVmejRGaEZIVkk0K003NUE9PSIsInZhbHVlIjoiQTgyRG1Ba2ZCdTZxcjVsTm9vV0hwQzRsVE9SWkJrR1hjdEVjaTYwbGFRQT0iLCJtYWMiOiJmNDZhMDUzMDI4M2RiZmFkMWU5YzVlNGQ5MTViMzlhODc4ZTRmMmRjM2Q5ZjZlY2I3NGUzOTJkZTI1MTg4YjczIiwidGFnIjoiIn0=",
      "is_imported": null,
      "lines": {
        "object": "list",
        "data": [
          {
            "object": "line_item",
            "id": 3408896,
            "amount": 3500,
            "created_at": "2023-02-21T13:06:48.000000Z",
            "currency": "cad",
            "deleted_at": null,
            "description": "1 × Accounting Product (at $35.00 / week)",
            "metadata": null,
            "object_id": "il_1MdvYRJSYlEHeD4bxqH3BaCK",
            "period": {
              "end": 1677589606,
              "start": 1676984806
            },
            "quantity": 1,
            "subscription": {
              "object": "subscription",
              "id": 2896258,
              "address_id": 8154404,
              "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"
              },
              "agency_id": null,
              "auto_renew": false,
              "backdate_start_date": null,
              "billing": "send_invoice",
              "billing_cycle_anchor": "2023-02-21T13:06:46.000000Z",
              "cancel_at": "2023-02-28T13:06:46.000000Z",
              "cancel_at_period_end": 1,
              "cancel_reason": null,
              "canceled_at": "2023-02-21T13:11:13.000000Z",
              "canceled_by_email": "[email protected]",
              "canceled_by_type": "Admin/Collaborator",
              "coupon": null,
              "created": "2023-02-21T13:06:46.000000Z",
              "current_period_end": "2023-02-28T13:06:46.000000Z",
              "current_period_start": "2023-02-21T13:06:46.000000Z",
              "customer": {
                "object": "customer",
                "id": 8194391,
                "balance": 0,
                "created": "2023-02-20T13:44:08.000000Z",
                "currency": "cad",
                "default_source": null,
                "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
              },
              "days_until_due": 30,
              "default_source": null,
              "default_tax_rates": null,
              "ended_at": null,
              "expires_at": 1677589606,
              "gift_code": null,
              "gift_donor_subscription_id": null,
              "gift_message": null,
              "gift_notification_sent": 0,
              "gift_recipient_email": null,
              "gift_recipient_first_name": null,
              "gift_recipient_last_name": null,
              "gift_start_date": null,
              "is_gift_donor": null,
              "is_gift_recipient": null,
              "is_redeemed": null,
              "latest_invoice": {
                "object": "invoice",
                "id": 2947310,
                "address_billing": null,
                "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": 0,
                "amount_paid": 3500,
                "amount_remaining": 0,
                "auto_advance": true,
                "billing": "send_invoice",
                "billing_address": null,
                "billing_reason": "subscription_create",
                "charge": {
                  "id": 1731973,
                  "offline": true,
                  "payment_category": "Wire",
                  "reference": "ayman"
                },
                "charge_id": 1731973,
                "created": "2023-02-21T13:06:47.000000Z",
                "currency": "cad",
                "customer": {
                  "object": "customer",
                  "id": 8194391,
                  "balance": 0,
                  "created": "2023-02-20T13:44:08.000000Z",
                  "currency": "cad",
                  "default_source": null,
                  "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": null,
                "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:06:47.000000Z",
                "hosted_invoice_url": "https://invoice.stripe.com/i/acct_1MD2qxJSYlEHeD4b/test_YWNjdF8xTUQycXhKU1lsRUhlRDRiLF9OT2owak5tSnFydFEzNUkyTnE5ZEF0NTNHUHB4cFFLLDY3NTI1ODk10200nT7aBa7x?s=ap",
                "invoice_pdf": "https://staging.pelcro.com/pdf/invoice/eyJpdiI6IjluNE51Y1FiWHhJL3FGR2F3SXNWNlE9PSIsInZhbHVlIjoiN1IwT3VyUU5VclNLd0d6N0xzcUFsNm1SVmlZYjg2cTFJY3VMcHVhOUJMST0iLCJtYWMiOiJjODYxN2ExMmZjZWEyYWUwMTA3ZjQyYzJmOGE4MjQ4ODEyOTJkOTIyNTY2YjcwZjY4MzVlZGY0MmI4MDk2M2YwIiwidGFnIjoiIn0=",
                "is_imported": null,
                "lines": {
                  "object": "list",
                  "data": [
                    {
                      "object": "line_item",
                      "id": 3408896,
                      "amount": 3500,
                      "created_at": "2023-02-21T13:06:48.000000Z",
                      "currency": "cad",
                      "deleted_at": null,
                      "description": "1 × Accounting Product (at $35.00 / week)",
                      "metadata": null,
                      "object_id": "il_1MdvYRJSYlEHeD4bxqH3BaCK",
                      "period": {
                        "end": 1677589606,
                        "start": 1676984806
                      },
                      "quantity": 1,
                      "tax_amounts": null,
                      "tax_rates": null,
                      "updated_at": "2023-02-21T13:06:48.000000Z"
                    }
                  ]
                },
                "marked_uncollectible_at": null,
                "number": "3D68210F-0006",
                "object_id": "in_1MdvYRJSYlEHeD4bbYnkFUcL",
                "paid_at": null,
                "period_end": "2023-02-21T13:06:46.000000Z",
                "period_start": "2023-02-21T13:06:46.000000Z",
                "plan": {
                  "id": 374852,
                  "nickname": "Membership_auto",
                  "interval": "week"
                },
                "post_payment_credit_notes_amount": 0,
                "pre_payment_credit_notes_amount": 0,
                "product": {
                  "id": 4857,
                  "name": "Accounting Product",
                  "name_internal": null
                },
                "purchase_order": null,
                "site_id": 775,
                "source": null,
                "starting_balance": 0,
                "status": "paid",
                "subscription": {
                  "object": "subscription",
                  "id": 2896258,
                  "billing": "send_invoice",
                  "cancel_at_period_end": 1,
                  "canceled_at": "2023-02-21T13:11:13.000000Z",
                  "created": "2023-02-21T13:06:46.000000Z",
                  "current_period_start": "2023-02-21T13:06:46.000000Z",
                  "current_period_end": "2023-02-28T13:06:46.000000Z",
                  "schedules": null,
                  "plan": {
                    "id": 374852,
                    "product_id": 4857,
                    "parent_plan_id": null,
                    "object_id": "plan_N14gAn6ZzPwsFi",
                    "active": "active",
                    "type": "membership",
                    "amount": 3500,
                    "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": 2,
                    "nickname": "Membership_auto",
                    "name_internal": null,
                    "refundable": true,
                    "shipments_per_interval": null,
                    "description": null,
                    "trial_period_days": 0,
                    "ip_addresses": null,
                    "domains": null,
                    "created_at": "2022-12-20T09:55:07.000000Z",
                    "updated_at": "2023-02-09T18:10:18.000000Z",
                    "site_ids": [
                      775
                    ],
                    "product": {
                      "id": 4857,
                      "object_id": "prod_MwzmDDN1FURUpM",
                      "type": "service",
                      "active": "active",
                      "address_required": null,
                      "countries": null,
                      "description": null,
                      "entitlements": null,
                      "is_imported": null,
                      "is_hidden": null,
                      "language": null,
                      "livemode": false,
                      "metadata": null,
                      "name": "Accounting Product",
                      "name_internal": null,
                      "shippable": null,
                      "statement_descriptor": null,
                      "created_at": "2022-12-09T12:34:55.000000Z",
                      "updated_at": "2022-12-09T12:34:55.000000Z",
                      "site_ids": [
                        775
                      ]
                    }
                  }
                },
                "subscription_id": 2896258,
                "subtotal": 3500,
                "tax": null,
                "tax_percent": null,
                "total": 3500,
                "total_tax_amounts": null,
                "updated_at": "2023-02-21T13:11:45.000000Z",
                "voided_at": null
              },
              "object_id": "sub_1MdvYRJSYlEHeD4bjO1lKh1X",
              "plan": {
                "id": 374852,
                "product_id": 4857,
                "parent_plan_id": null,
                "object_id": "plan_N14gAn6ZzPwsFi",
                "active": "active",
                "type": "membership",
                "amount": 3500,
                "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": 2,
                "nickname": "Membership_auto",
                "name_internal": null,
                "refundable": true,
                "shipments_per_interval": null,
                "description": null,
                "trial_period_days": 0,
                "ip_addresses": null,
                "domains": null,
                "created_at": "2022-12-20T09:55:07.000000Z",
                "updated_at": "2023-02-09T18:10:18.000000Z",
                "site_ids": [
                  775
                ],
                "product": {
                  "id": 4857,
                  "object_id": "prod_MwzmDDN1FURUpM",
                  "type": "service",
                  "active": "active",
                  "address_required": null,
                  "countries": null,
                  "description": null,
                  "entitlements": null,
                  "is_imported": null,
                  "is_hidden": null,
                  "language": null,
                  "livemode": false,
                  "metadata": null,
                  "name": "Accounting Product",
                  "name_internal": null,
                  "shippable": null,
                  "statement_descriptor": null,
                  "created_at": "2022-12-09T12:34:55.000000Z",
                  "updated_at": "2022-12-09T12:34:55.000000Z",
                  "site_ids": [
                    775
                  ]
                }
              },
              "quantity": 1,
              "renews_at": null,
              "schedules": null,
              "shipments_remaining": null,
              "shipments_suspended_until": null,
              "shipments_undeliverable": false,
              "shipping_address": {
                "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"
              },
              "site_id": 775,
              "source": "Web",
              "start_date": "2023-02-21T13:06:46.000000Z",
              "status": "active",
              "trial_end": null,
              "trial_start": null
            },
            "tax_amounts": null,
            "tax_rates": null,
            "updated_at": "2023-02-21T13:06:48.000000Z"
          }
        ]
      },
      "marked_uncollectible_at": null,
      "number": "3D68210F-0006",
      "object_id": "in_1MdvYRJSYlEHeD4bbYnkFUcL",
      "paid_at": null,
      "period_end": "2023-02-21T13:06:46.000000Z",
      "period_start": "2023-02-21T13:06:46.000000Z",
      "plan": {
        "id": 374852,
        "nickname": "Membership_auto",
        "interval": "week"
      },
      "post_payment_credit_notes_amount": 0,
      "pre_payment_credit_notes_amount": 0,
      "product": {
        "id": 4857,
        "name": "Accounting Product",
        "name_internal": null
      },
      "purchase_order": null,
      "site_id": 775,
      "source": null,
      "starting_balance": 0,
      "status": "paid",
      "subscription": {
        "object": "subscription",
        "id": 2896258,
        "billing": "send_invoice",
        "cancel_at_period_end": 1,
        "canceled_at": "2023-02-21T13:11:13.000000Z",
        "created": "2023-02-21T13:06:46.000000Z",
        "current_period_start": "2023-02-21T13:06:46.000000Z",
        "current_period_end": "2023-02-28T13:06:46.000000Z",
        "schedules": null,
        "plan": {
          "id": 374852,
          "product_id": 4857,
          "parent_plan_id": null,
          "object_id": "plan_N14gAn6ZzPwsFi",
          "active": "active",
          "type": "membership",
          "amount": 3500,
          "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": 2,
          "nickname": "Membership_auto",
          "name_internal": null,
          "refundable": true,
          "shipments_per_interval": null,
          "description": null,
          "trial_period_days": 0,
          "ip_addresses": null,
          "domains": null,
          "created_at": "2022-12-20T09:55:07.000000Z",
          "updated_at": "2023-02-09T18:10:18.000000Z",
          "site_ids": [
            775
          ],
          "product": {
            "id": 4857,
            "object_id": "prod_MwzmDDN1FURUpM",
            "type": "service",
            "active": "active",
            "address_required": null,
            "countries": null,
            "description": null,
            "entitlements": null,
            "is_imported": null,
            "is_hidden": null,
            "language": null,
            "livemode": false,
            "metadata": null,
            "name": "Accounting Product",
            "name_internal": null,
            "shippable": null,
            "statement_descriptor": null,
            "created_at": "2022-12-09T12:34:55.000000Z",
            "updated_at": "2022-12-09T12:34:55.000000Z",
            "site_ids": [
              775
            ]
          }
        }
      },
      "subscription_id": 2896258,
      "subtotal": 3500,
      "tax": null,
      "tax_percent": null,
      "total": 3500,
      "total_tax_amounts": null,
      "updated_at": "2023-02-21T13:11:45.000000Z",
      "voided_at": null
    },
    "previous_attributes": {
      "charge_id": 1731973,
      "amount_due": 0,
      "amount_paid": 3500,
      "amount_remaining": 0,
      "status": "paid",
      "updated_at": "2023-02-21T13:11:45.000000Z"
    }
  }
}