How to integrate Chargebee Retention and Chargebee Billing?

Modified on: Fri, 7 Oct, 2022 at 8:33 PM


How to integrate Chargebee Retention and Chargebee Billing?

Chargebee Retention integration

What are the steps to integrate Chargebee Retention?


To integrate Chargebee Retention, go to Configure Chargebee > Customer-Facing Essentials and select Chargebee Retention and enable it.

We now provide you with two options to integrate Chargebee Retention and Chargebee Billing. They are:

  • Signup Flow within Configure Chargebee
  • API Keys in Chargebee Retention Settings

If you are currently a Chargebee merchant, we recommend that you use the signup flow as this will automatically establish the correct API key, sync it with Chargebee Retention, and enable either the Portal Integration or Retention API instructions.

Signup Flow within Configure Chargebee

Chargebee Billing merchants can now integrate their site with Chargebee Retention via the Configure Chargebee Settings. Doing so will create a free 30-day trial of Chargebee Retention's Essentials plan that is automatically linked to your Chargebee Billing site via an API key. 

Navigate to Configure Chargebee > Customer-Facing Essentials and select Chargebee Retention

This will take you to a landing page where you can initiate this signup flow. You will be prompted to create your company where you will provide a Company Name, Company Key (must be unique and will be autogenerated from the name), and domain.

Once you have provided these, we will ask you to create a user login with Chargebee Retention either using Google authentication or a username and password. 

Once you have logged in, you will be routed to the Chargebee Retention Dashboard and your site will be connected to Chargebee Retention via an API key we automatically generate.

Once you are integrated, you will need to go through the Steps to get Chargebee Retention ready to launch for Billing Merchants from this link. If you have any questions about how this signup flow works, please contact

API Keys in Chargebee Retention Settings

An alternative option is to create your API Keys and integrate Chargebee Billing + Chargebee Retention yourself via the Retention Settings. You will want to pick a 'Full-Access' key if you plan to utilize the Manage Cancel feature to update subscriptions. 

Once you have created your key, you can add it to Chargebee Retention.

We allow you to map both a Live and Test site Key into Chargebee Retention. For testing your Cancel Experience, refer to this link.


Note: If you choose this route and want to integrate Chargebee via the Customer Portal or Retention API, we will need to configure an additional setting for you. Please either use the signup flow above or contact and we will assist you.

You also can review the full set of features we offer with our Chargebee Retention from this link.

Related Articles

What is Chargebee Retention? 

How to Integrate Chargebee Retention and Chargebee Billing? 

How to configure Enrichment in Chargebee Retention? 

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.