Subscription payment information changed event

Understand the subscription payment information changed event.

The subscription.payment_info_changed event is a crucial notification in subscription management systems. This event is triggered when there has been an update to a subscriber's payment information through an entry point. This update could be related to the credit card details, billing address, or even the choice of payment method.

When this event is triggered, a JSON payload is provided, which includes detailed information about the subscription affected by the update. Details include:

  • Basic subscription identifiers (creation and activation dates, next renewal date, etc.)

  • Shopper information

  • Updated payment option details

  • Product and pricing information

Efficient monitoring and handling of the subscription.payment_info_changed event ensures seamless subscription management and maintains up-to-date records of subscribers' payment methods.

{
    "type": "subscription.payment_info_changed",
    "data": {
        "object": {
            "id": "12060199",
            "creationDate": "2022-05-18T16:50:53.000Z",
            "activationDate": "2022-05-18T05:00:00.000Z",
            "nextRenewalDate": "2023-05-18T05:00:00.000Z",
            "expirationDate": "2023-05-18T05:00:00.000Z",
            "graceDate": "2023-05-18T05:00:00.000Z",
            "currentQuantity": 1,
            "renewalQuantity": 1,
            "autoRenewal": false,
            "locale": "en_US",
            "state": "Subscribed",
            "duration": 365,
            "frequency": 365,
            "siteId": "sub2test",
            "shopper": {
                "id": "26092509660199"
            },
            "renewalPrice": {
                "unitPrice": 9.0,
                "locked": false,
                "currency": "USD"
            },
            "term": {
                "termUnit": "YEARS",
                "termLength": 1
            },
            "product": {
                "id": "5396391800",
                "displayName": "Annual manual renewal Subscription",
                "sku": "SUB_MANUAL_RENEW"
            },
            "shipToAddress": {
                "id": "406026490199",
                "firstName": "Monika",
                "lastName": "Yadav",
                "companyName": "ABC",
                "line1": "Add1",
                "city": "Kansus",
                "postalCode": "123432",
                "countrySubdivision": "AA",
                "country": "VN",
                "countryName": "Vietnam",
                "phoneNumber": "7895673452",
                "emailAddress": "test@dr2.com"
            },
            "paymentOption": {
                "nickName": "Default",
                "id": "4022810199",
                "isDefault": "true",
                "type": "CreditCardMethod",
                "creditCard": {
                    "expirationMonth": "3",
                    "expirationYear": "2025",
                    "displayableNumber": "************1111",
                    "type": "visa",
                    "displayName": "Visa"
                },
                "address": {
                    "id": "406026480199",
                    "firstName": "Monika",
                    "lastName": "Yadav",
                    "companyName": "ABC",
                    "line1": "Add1",
                    "city": "Kansus",
                    "postalCode": "123432",
                    "countrySubdivision": "AA",
                    "country": "VN",
                    "countryName": "Vietnam",
                    "phoneNumber": "7895673452",
                    "emailAddress": "test@dr2.com"
                }
            },
            "addOns": []
        }
    },
      "clientIds":{
      "site_id":"sub2test"
   },
   "searchableData":{
      "subscriptionId":"12060199"
   }
}
PreviousSubscription credit card expired eventNextSubscription renewal reminder event

Last updated