subscription.renewed

The subscription.renewed event is triggered whenever the subscription is renewed and a new phase is added to the subscription.

{
    "type": "subscription.renewed",
    "id": "evt_lwFv5xrjscGoaU8CYroBdvGu",
    "created": 1624531657,
    "triggered_from": "open_api",
    "data": {
        "object": {
            "object": "subscription",
            "id": 70,
            "address_id": null,
            "campaign_id": null,
           "metadata" : [
               "metadata-example1",
               "metadata-example2",
            ],
            "campaign_key":null,
            "address_shipping": {
                "object": "address",
                "id": 43,
                "city": "city name",
                "company": "company name",
                "country": "CA",
                "country_name": "Canada",
                "created_at": "2021-06-24 10:21:26",
                "department": "which department",
                "first_name": "first name",
                "is_default": true,
                "last_name": "last name",
                "line1": "specific address",
                "line2": "apt 100",
                "postal_code": "12345",
                "salutation": null,
                "state": "QC",
                "state_name": "Quebec",
                "title": "title name",
                "type": "shipping",
                "updated_at": "2021-06-24 10:22:48"
            },
            "agency_id": null,
            "auto_renew": true,
            "backdate_start_date": null,
            "billing": "charge_automatically",
            "billing_cycle_anchor": "2021-06-24 10:33:02",
            "campaign_id": 5374,
            "campaign_key": "InstantPromo",
            "cancel_at": null,
            "cancel_at_period_end": 0,
            "cancel_reason": null,
            "canceled_at": null,
            "coupon": null,
            "created": "2021-06-24 10:33:02",
            "current_period_end": "2022-06-24 10:33:02",
            "current_period_start": "2021-06-24 10:33:02",
            "customer": {
                "object": "customer",
                "id": 64,
                "balance": 0,
                "created": "2021-06-24 10:16:11",
                "currency": "cad",
                "default_source": {
                    "object": "source",
                    "id": 106,
                    "address_line1_check": "pass",
                    "address_zip_check": "pass",
                    "brand": "Visa",
                    "country": "US",
                    "cvc_check": "pass",
                    "dynamic_last4": null,
                    "exp_month": 5,
                    "exp_year": 2022,
                    "fingerprint": "b20EgCMpRnuPYluY",
                    "funding": "credit",
                    "last4": "0019",
                    "name": null,
                    "three_d_secure": "optional",
                    "tokenization_method": null
                },
                "delinquent": false,
                "display_name": "display_name",
                "email": "[email protected]",
                "email_confirm": null,
                "first_name": "first name",
                "has_password": 0,
                "language": null,
      					"last_login_method": 'email',
                "last_name": "last name",
                "metadata": {
                    "pelcro_account_id": "1",
                    "pelcro_customer_id": "64"
                },
                "phone": "12345678",
                "phone_confirm": null,
                "salutation": "salutation",
                "title": "title",
      					"username": null
            },
            "days_until_due": null,
            "default_source": {
                "object": "source",
                "id": 106,
                "address_line1_check": "pass",
                "address_zip_check": "pass",
                "brand": "Visa",
                "country": "US",
                "cvc_check": "pass",
                "dynamic_last4": null,
                "exp_month": 5,
                "exp_year": 2022,
                "fingerprint": "b20EgCMpRnuPYluY",
                "funding": "credit",
                "last4": "0019",
                "name": null,
                "three_d_secure": "optional",
                "tokenization_method": null
            },
            "default_tax_rates": null,
            "ended_at": null,
            "expires_at": null,
            "gift_code": null,
            "gift_donor_subscription_id": null,
            "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": 158,
                "address_billing": {
                    "object": "address",
                    "id": 44,
                    "city": "cit",
                    "company": null,
                    "country": "CA",
                    "country_name": "Canada",
                    "created_at": "2021-06-24 10:28:08",
                    "department": null,
                    "first_name": "first name",
                    "is_default": true,
                    "last_name": "last name",
                    "line1": "ad",
                    "line2": null,
                    "postal_code": "12345",
                    "salutation": null,
                    "state": "QC",
                    "state_name": "Quebec",
                    "title": null,
                    "type": "billing",
                    "updated_at": "2021-06-24 10:28:08"
                },
                "address_shipping": null,
                "amount_due": 20000,
                "amount_paid": 20000,
                "amount_remaining": 0,
                "auto_advance": false,
                "billing": "charge_automatically",
                "billing_address": {
                    "object": "address",
                    "id": 44,
                    "city": "cit",
                    "company": null,
                    "country": "CA",
                    "country_name": "Canada",
                    "created_at": "2021-06-24 10:28:08",
                    "department": null,
                    "first_name": "first name",
                    "is_default": true,
                    "last_name": "last name",
                    "line1": "ad",
                    "line2": null,
                    "postal_code": "12345",
                    "salutation": null,
                    "state": "QC",
                    "state_name": "Quebec",
                    "title": null,
                    "type": "billing",
                    "updated_at": "2021-06-24 10:28:08"
                },
                "billing_reason": "subscription_create",
                "charge_id": 85,
                "created": "2021-06-24 10:33:02",
                "currency": "cad",
                "customer": {
                    "object": "customer",
                    "id": 64,
                    "balance": 0,
                    "created": "2021-06-24 10:16:11",
                    "currency": "cad",
                    "default_source": {
                        "object": "source",
                        "id": 106,
                        "address_line1_check": "pass",
                        "address_zip_check": "pass",
                        "brand": "Visa",
                        "country": "US",
                        "cvc_check": "pass",
                        "dynamic_last4": null,
                        "exp_month": 5,
                        "exp_year": 2022,
                        "fingerprint": "b20EgCMpRnuPYluY",
                        "funding": "credit",
                        "last4": "0019",
                        "name": null,
                        "three_d_secure": "optional",
                        "tokenization_method": null
                    },
                    "delinquent": false,
                    "display_name": "display_name",
                    "email": "[email protected]",
                    "email_confirm": null,
                    "first_name": "first name",
                    "has_password": 0,
                    "language": null,
      							"last_login_method": 'email',
                    "last_name": "last name",
                    "metadata": {
                        "pelcro_account_id": "1",
                        "pelcro_customer_id": "64"
                    },
                    "phone": "12345678",
                    "phone_confirm": null,
                    "salutation": "salutation",
                    "title": "title",
      							"username": null
                },
                "customer_address": {
                    "city": "cit",
                    "country": "CA",
                    "line1": "ad",
                    "line2": null,
                    "postal_code": "12345",
                    "state": "QC"
                },
                "customer_shipping": null,
                "default_tax_rates": null,
                "deleted_at": null,
                "discount_id": null,
                "ending_balance": 0,
                "finalized_at": "2021-06-24 10:33:02",
                "is_imported": null,
                "lines": {
                    "object": "list",
                    "data": [
                        {
                            "object": "line_item",
                            "id": 158,
                            "amount": 20000,
                            "created_at": "2021-06-24 10:33:07",
                            "currency": "cad",
                            "deleted_at": null,
                            "description": "1 × Cool product (at $200.00 / year)",
                            "metadata": {
                                "pelcro_site_id": "1",
                                "pelcro_subscription_id": "70"
                            },
                            "period": {
                                "end": 1656066782,
                                "start": 1624530782
                            },
                            "quantity": 1,
                            "tax_amounts": null,
                            "tax_rates": null,
                            "updated_at": "2021-06-24 10:33:07"
                        }
                    ]
                },
                "marked_uncollectible_at": null,
                "number": "5408B141-0001",
                "paid_at": "2021-06-24 10:33:02",
                "period_end": "2021-06-24 10:33:02",
                "period_start": "2021-06-24 10:33:02",
                "post_payment_credit_notes_amount": 0,
                "pre_payment_credit_notes_amount": 0,
                "purchase_order": null,
                "source": {
                    "object": "source",
                    "id": 106,
                    "address_line1_check": "pass",
                    "address_zip_check": "pass",
                    "brand": "Visa",
                    "country": "US",
                    "cvc_check": "pass",
                    "dynamic_last4": null,
                    "exp_month": 5,
                    "exp_year": 2022,
                    "fingerprint": "b20EgCMpRnuPYluY",
                    "funding": "credit",
                    "last4": "0019",
                    "name": null,
                    "three_d_secure": "optional",
                    "tokenization_method": null
                },
                "plan": {
                    "id": 1,
                    "nickname": "test",
                    "interval": "day"
                },
                "product": {
                    "id": 1,
                    "name": "test",
                    "name_internal": null
                },
                "subscription_id": 10,
                "starting_balance": 0,
                "status": "paid",
                "subtotal": 20000,
                "tax": null,
                "tax_percent": null,
                "total": 20000,
                "total_tax_amounts": null,
                "updated_at": "2021-06-24 10:33:09",
                "voided_at": null
            },
            "plan": {
                "object": "plan",
                "id": 1,
                "active": "active",
                "amount": 20000,
                "currency": "cad",
                "domains": null,
                "description": null,
                "entitlements": null,
                "group_owner_plan_id": null,
                "interval": "year",
                "interval_count": 1,
                "nickname": "$200 CAD / auto-renew / Yearly",
                "name_internal": "$200 CAD / auto-renew / Yearly",
                "type": "regular",
                "trial_period_days": 0,
                "ip_addresses": null,
                "product": {
                    "object": "product",
                    "id": 1,
                    "type": "service",
                    "active": "active",
                    "address_required": 0,
                    "description": "Cool product",
                    "livemode": false,
                    "is_hidden": null,
                    "name": "Cool product",
                    "package_dimensions": null,
                    "shippable": null,
                    "statement_descriptor": "Cool product",
                    "unit_label": null
                }
            },
            "quantity": 1,
            "renews_at": 1656066782,
            "schedules": {
                "object": "list",
                "data": [
                    {
                        "billing": "charge_automatically",
                        "canceled_at": null,
                        "collection_method": "charge_automatically",
                        "completed_at": null,
                        "created": "2021-06-24 10:47:36",
                        "current_phase": {
                            "end_date": 1656066782,
                            "start_date": 1624530782
                        },
                        "current_phase_start_date": "2021-06-24 10:33:02",
                        "current_phase_end_date": "2022-06-24 10:33:02",
                        "default_settings": {
                            "application_fee_percent": null,
                            "automatic_tax": {
                                "enabled": false
                            },
                            "billing_cycle_anchor": "automatic",
                            "billing_thresholds": null,
                            "collection_method": "charge_automatically",
                            "default_payment_method": null,
                            "default_source": "src_1J5pzHJ791D5QhBigcZKjfSt",
                            "invoice_settings": {
                                "days_until_due": null
                            },
                            "transfer_data": null
                        },
                        "end_behavior": "release",
                        "invoice_settings": {
                            "days_until_due": null
                        },
                        "metadata": null,
                        "released_at": null,
                        "renewal_behavior": "release",
                        "status": "active",
                        "object": "subscription_schedule",
                        "phases": {
                            "object": "list",
                            "data": [
                                {
                                    "collection_method": "charge_automatically",
                                    "end_date": "2022-06-24 10:33:02",
                                    "invoice_settings": null,
                                    "start_date": "2021-06-24 10:33:02",
                                    "tax_percent": null,
                                    "trial_end": null,
                                    "created_at": "2021-06-24 10:47:37",
                                    "updated_at": "2021-06-24 10:47:37",
                                    "coupon": null,
                                    "plans": {
                                        "object": "list",
                                        "data": [
                                            {
                                                "index": 0,
                                                "billing_thresholds": null,
                                                "quantity": 1,
                                                "plan": {
                                                    "object": "plan",
                                                    "id": 1,
                                                    "active": "active",
                                                    "amount": 20000,
                                                    "currency": "cad",
                                                    "entitlements": null,
                                                    "group_owner_plan_id": null,
                                                    "interval": "year",
                                                    "interval_count": 1,
                                                    "nickname": "$200 CAD / auto-renew / Yearly",
                                                    "name_internal": "$200 CAD / auto-renew / Yearly",
                                                    "type": "regular",
                                                    "trial_period_days": 0,
                                                    "product": {
                                                        "object": "product",
                                                        "id": 1,
                                                        "type": "service",
                                                        "active": "active",
                                                        "address_required": 0,
                                                        "description": "Cool product",
                                                        "livemode": false,
                                                        "is_hidden": null,
                                                        "name": "Cool product",
                                                        "package_dimensions": null,
                                                        "shippable": null,
                                                        "statement_descriptor": "Cool product",
                                                        "unit_label": null
                                                    }
                                                },
                                                "object": "subscription_schedule_phase_plan"
                                            }
                                        ]
                                    },
                                    "object": "subscription_schedule_phase"
                                },
                                {
                                    "collection_method": "charge_automatically",
                                    "end_date": "2022-07-01 10:33:02",
                                    "invoice_settings": null,
                                    "start_date": "2022-06-24 10:33:02",
                                    "tax_percent": null,
                                    "trial_end": null,
                                    "created_at": "2021-06-24 10:47:37",
                                    "updated_at": "2021-06-24 10:47:37",
                                    "coupon": null,
                                    "plans": {
                                        "object": "list",
                                        "data": [
                                            {
                                                "index": 0,
                                                "billing_thresholds": null,
                                                "quantity": 1,
                                                "plan": {
                                                    "object": "plan",
                                                    "id": 4,
                                                    "active": "active",
                                                    "amount": 8000,
                                                    "currency": "cad",
                                                    "entitlements": null,
                                                    "group_owner_plan_id": null,
                                                    "interval": "week",
                                                    "interval_count": 1,
                                                    "nickname": "80 CAD Weekly / auto-renew",
                                                    "name_internal": "80 CAD Weekly / auto-renew",
                                                    "type": "regular",
                                                    "trial_period_days": 0,
                                                    "product": {
                                                        "object": "product",
                                                        "id": 1,
                                                        "type": "service",
                                                        "active": "active",
                                                        "address_required": 0,
                                                        "description": "Cool product",
                                                        "livemode": false,
                                                        "is_hidden": null,
                                                        "name": "Cool product",
                                                        "package_dimensions": null,
                                                        "shippable": null,
                                                        "statement_descriptor": "Cool product",
                                                        "unit_label": null
                                                    }
                                                },
                                                "object": "subscription_schedule_phase_plan"
                                            }
                                        ]
                                    },
                                    "object": "subscription_schedule_phase"
                                }
                            ]
                        }
                    }
                ]
            },
            "shipments_remaining": null,
            "shipments_suspended_until": null,
            "shipments_undeliverable": false,
            "shipping_address": {
                "object": "address",
                "id": 43,
                "city": "city name",
                "company": "company name",
                "country": "CA",
                "country_name": "Canada",
                "created_at": "2021-06-24 10:21:26",
                "department": "which department",
                "first_name": "first name",
                "is_default": true,
                "last_name": "last name",
                "line1": "specific address",
                "line2": "apt 100",
                "postal_code": "12345",
                "salutation": null,
                "state": "QC",
                "state_name": "Quebec",
                "title": "title name",
                "type": "shipping",
                "updated_at": "2021-06-24 10:22:48"
            },
            "site_id": 1,
            "source": "Phone",
            "start_date": "2021-06-24 10:33:02",
            "status": "active",
            "trial_end": null,
            "trial_start": null
        }
    }
}