System Status

Subscription cancelled event

Understand the subscription cancelled event.

The subscription.cancelled event event signifies a crucial point in the lifecycle of a subscription-based service. This event occurs when a subscription is terminated due to the subscriber's explicit cancellation or an unintentional lapse, such as a failed recurring payment. This guide provides an overview of the subscription.cancelled event, detailing its structure, the critical data it encompasses, and its implications for subscription management. By understanding and effectively responding to this event, businesses can manage subscription cancellations smoothly while also leveraging the opportunity to engage with customers and potentially address any concerns or issues leading to the cancellation.

The subscription.cancelled event is triggered when a subscriber either cancels their subscription or when a recurring payment fails, resulting in the cancellation of the subscription. This event provides a detailed snapshot of the subscription at the time of cancellation, including but not limited to the subscription ID, cancellation date, and relevant customer and product information. It plays a crucial role in subscription lifecycle management by ensuring that access to services or products is accurately revoked or adjusted based on the subscriber's current status.

{
    "type": "subscription.cancelled",
    "data": {
        "object": {
            "id": "15547380289",
            "creationDate": "2022-03-29T06:55:05.000Z",
            "activationDate": "2022-03-29T05:00:00.000Z",
            "nextRenewalDate": "2022-04-29T05:00:00.000Z",
            "expirationDate": "2022-04-29T05:00:00.000Z",
            "graceDate": "2022-05-06T05:00:00.000Z",
            "cancellationDate": "2022-03-29T05:00:00.000Z",
            "currentQuantity": 1,
            "renewalQuantity": 1,
            "autoRenewal": true,
            "locale": "en_US",
            "state": "Cancelled",
            "duration": 31,
            "frequency": 31,
            "siteId": "sub2test",
            "shopper": {
                "id": "504455390289",
                "externalReferenceId": "ZPQRTQHL16J5"
            },
            "term": {
                "termUnit": "MONTHS",
                "termLength": 1
            },
            "product": {
                "id": "5367865200",
                "displayName": "APM_2_months_auto",
                "sku": "SUBS_COMMITMENT"
            },
            "shipToAddress": {
                "id": "330005680289",
                "firstName": "Subscription",
                "lastName": "Automation",
                "companyName": "DR",
                "line1": "10380 Bren Rd W",
                "line2": "Conjunto 304",
                "line3": "Conjunto 304",
                "city": "Minnetonka",
                "postalCode": "55343",
                "countrySubdivision": "MN",
                "country": "US",
                "countryName": "United States",
                "phoneNumber": "952-253-1234",
                "emailAddress": "subs_03292022015448AM370GVTDH@digitalriver.com",
                "countyName": "Minnetonka"
            },
            "paymentOption": {
                "nickName": "VisaUNIU910",
                "id": "16070210289",
                "isDefault": "true",
                "type": "CreditCardMethod",
                "creditCard": {
                    "expirationMonth": "3",
                    "expirationYear": "2024",
                    "displayableNumber": "************1111",
                    "type": "visa",
                    "displayName": "Visa"
                },
                "address": {
                    "id": "330108580289",
                    "firstName": "Subscription",
                    "lastName": "Automation",
                    "companyName": "DR",
                    "line1": "10380 Bren Rd W",
                    "line2": "Conjunto 304",
                    "line3": "Conjunto 304",
                    "city": "Minnetonka",
                    "postalCode": "55343",
                    "countrySubdivision": "MN",
                    "country": "US",
                    "countryName": "United States",
                    "phoneNumber": "952-253-1234",
                    "emailAddress": "subs_03292022015448AM370GVTDH@digitalriver.com",
                    "countyName": "Minnetonka"
                }
            },
            "addOns": []
        }
    },
   "clientIds":{
      "site_id":"sub2test"
   },
   "searchableData":{
      "subscriptionId":"15547380289"
   }
}

Next steps for handling a cancelled subscription

Once a subscription has been marked as canceled, it is important to take the following steps to ensure a smooth transition and maintain a positive relationship with the customer:

  • Communication with the customer:

    • Send a confirmation email to the customer acknowledging the cancellation.

    • Offer assistance or ask for feedback on why they cancelled the subscription.

PreviousSubscription action processed eventNextSubscription credit card expired event

Last updated