Testing with the Sample Session Generator 

The Sample Session Generator allows you to test the various components of your Chargebee Retention set up to ensure they are working properly for end users.

This tool will generate a live Chargebee Retention session that will trigger all events/alerts and end-user actions associated with the Experience, but it will not be counted in reporting or against your session limit. You can access this tool from two locations:

The form allows you to choose to test a specific page or the Targeting rules you have built out. If you select the Targeting rules, you will want to pick a test record that has the correct field values set on it to match the desired Targeting rule in Chargebee Retention.

You also have the option to test the Live or Draft version of a page, which allows you to preview your changes before they go live to end-users to ensure everything is working properly.

If you have an integrated Billing system with Enrichment enabled, then you will see the option to either look up a subscriber ID by email in that system or a field to input a subscriber ID into the test session. You will need a real subscription record for this test to work as we validate that record in your Billing system as part of the Enrichment call. We provide the option to test against either a Live or Test API key to give you the flexibility to test on either your prod Billing environment or your sandbox.


The actions associated with this test session will be processed, which means that we will update the subscription record to reflect the cancel or offer accept that occurred. Be careful not to plug in a subscription ID that you do not actually want to test this functionality on.

If you do not have Billing integrated, the form will look a little different. You will have the option to generate a random email + internal id or can input one yourself. There is no lookup to Billing here, so any random ID will work.

If you have any questions about how to use this Sample Session Generator, please contact

Was this article helpful?