• Process via dynamic URL redirect
• Process via webhook
• Process via email

Solution

Processing offers via dynamic URL redirect

The most common way our customers choose to process offers is by using a static URL placed in the Chargebee Retention offer editor, or by passing a dynamic URL along in the precancel request that defines your canceller's profile. Chargebee Retention has a pre-defined key that you can use to send a URL that can be placed in experiences. That key is the save_return_url. Typically our customers will use the save_return_url to return customers back to their subscription settings. Our standard field mapping will allow the dynamic URL to be used in cancel sessions when placed as the URL redirect option for your modal or button. 

Note: If you are unfamiliar with how Chargebee Retention precancel requests work, check out our brief tutorial, Installing Chargebee Retention.js

Note: We've already placed the save_return_url as the nevermind buttons and back buttons in confirmation modals. Using the above expression can apply a unique URL for your canceller to follow that will come across to your endpoint as a GET request. When the user clicks Nevermind they will be redirected to the endpoint you have defined in the precancel request. In this way, you can dynamically append query parameters to your endpoint and trigger follow-up actions in your billing or other systems

Dynamic URL example

Note: In this example, [INTERNAL_USER_ID], represents the dynamic variable to be passed along with each precancel request you can pass as many query parameters as are necessary to process your internal automation

"save_return_url" : "https://www.example.com/brightback?save=true&id=[INTERNAL_USER_ID]"

If desired, a combination of dynamic elements passed through the snippet and static query parameters can be formed in the Chargebee Retention offer editor to provide more flexibility for your admins. In the following example, we'll pass a base URL for applying a promo code to a subscription with a dynamic internal id and static promo code that can easily be updated at any time. 

"promo_code_url" : "https://www.example.com/brightback?id=[INTERNAL_USER_ID]&promo_code="

You can see that the base URL above does not include the promo code to be applied.  We'll do that inside of the Chargebee offer editor.

Note that you can't enter any spaces or illegal characters in the URL editor.

The resulting URL will be fully formed when your canceller accepts the offer and a query parameter of promo_code=BB10 will be attached to the URL. If your user's id was 123 for instance. The end result would look like the following.

https://www.example.com/brightback?id=123&promo_code=BB10

Processing offers via webhook

Using Chargebee Retention webhook notification system is a powerful way to process offers. In order to utilize our webhook notifications, you'll first need to create an endpoint that can accept POST requests. If you are considering this option and want to take a deeper look into how to authenticate and read the request body for offers, please take a look at our help article, Using Webhooks. 

Requests will all come calling from the Chargebee Retention block of static IPs that you can whitelist for your app in order to receive requests. The body of the POST request comes in standard JSON format with a number of keys you can use to trigger follow-up automation and processing, first and most notable is the notification type. In this case, it will be, 'Offer'.

{
  "data": {
    "type": "offer"
  }
}

The POST request will also include responses from the survey which are the canceller's reason for leaving, likelihood to return, competition, and free form feedback text from the additional comments box if they were filled out at the time the user accepted the offer.  

Note: The "offer" key holds the information you can use to trigger your follow-up automation. We'll include a unique name created when the offer was created which is immutable, the display name from the offer editor and the immutable "name" key which is generated when the offer is created.

{
  "data": {
    "offer": {
      "name": "100_dollar_discount.1694114780",
      "display_name": "100 dollar discount",
      "type": "Discount",
      "category": "$"
    }
  }
}

HTTP response codes:
By default we consider responses in the 200's to be a success. In the event you receive an event and do not wish to process it, please respond with code 422.
e.g. If you are filtering out certain offers by parsing the payload. Send a 422 response code if you received it but do not wish to perform any downstream processing.

Additionally, the field key will contain all of the profile information sent to us at the time of the precancel request. 

{
  "data": {
  "fields": {
      "cancel.app_id": "bAJDE0xo5E",
      "cancel.first_name": "Jane",
      "cancel.account.created_at": "1622050643",
      "cancel.account.plan_term": "monthly",
      "cancel.account.value": "1234",
      "cancel.save_return_url": "http://brightback.com?save_return_url",
      "cancel.last_name": "Brighteyes",
      "cancel.account.company_name": "Brightback",
      "cancel.custom.test": "value",
      "cancel.account.plan": "Premium",
      "cancel.email": "[email protected]",
      "cancel.account.billing_id": "",
      "cancel.context.url": "about:srcdoc",
      "cancel.timestamp": "2021-05-26T17:38:43.361Z",
      "cancel.account.internal_id": "b5a01a2",
      "cancel.subscription_id": "1234",
    }
  }
}

Processing offers via email

Using Chargebee's email notification system is another option for you if you intend to have agents processing offers manually in your billing system or if you would like to trigger follow-up workflows in your helpdesk.

Note: All Chargebee notification emails come from [email protected]. Ensure that you have whitelisted that email address in your helpdesk

You will want to turn on the offer event notification and add an email address to which all offer accept emails should go. Head over to Settings > Alerts and edit the Accept Offer alert.

Activate the alert and edit the content of the email notification. You can include dynamically mapped expressions, such as name, email, and internal_id, as well as unique survey responses (if they were filled out at the time the offer was accepted). Reach out to us at [email protected] if you have any questions.

Related Articles

How to create the best offer in Chargebee Retention?