Getting Started

Product Catalog



Invoices, Credit Notes and Quotes



Site Configuration

Data Privacy & Security

Data Operations

Reports and Analytics


Installation Guide 

This page is for a legacy version of the integration that maps Chargebee customers to contacts in Salesforce. The version was deprecated on 6th Jan 2020. If you have not migrated to the latest version (with account-based mapping), please contact [email protected] .

The integration must be setup exactly as described on this page. So follow the steps carefully. Do get in touch with us at [email protected] if you have any concerns.


Multiple Chargebee sites
If you are connecting multiple Chargebee sites with the same Salesforce  org, perform the steps given below for each of the Chargebee sites.

Step 1: Connect Chargebee to Salesforce 

Test then Live
Before integrating your Chargebee live site(s) with your Salesforce production org, it is imperative that you test your workflows fully using the Chargebee test site(s) connected with a Salesforce sandbox account loaded with a copy of your production data.


Package version
If you are connecting multiple Chargebee sites to the same Salesforce instance, ensure that your Chargebee for Salesforce package version is at least v1.21. Connecting a second Chargebee site when a lower version of the package is installed leads to erroneous behavior.

Check your package version and contact [email protected]  get the link for the latest package.

  1. On your Chargebee site, navigate to Settings > Third Party Integrations > Salesforce. Click Connect. You are lead to the Salesforce sandbox  or Salesforce production login page based on whether you are connecting from a Chargebee test site or live site respectively.

If you don't see the option to connect, write to [email protected]  or contact your Chargebee sales or Customer Success representative to enable the integration.

  1. Sign into the Salesforce sandbox/production org using a user account created exclusively for the Chargebee integration. This ensures that changes made by the integration are clearly identified and not mistaken for changes made by other users.

Step 2: Install the package. 

Once logged into Salesforce, the package installation process starts.

When you see the Install Chargebee for Salesforce page, choose Install for Specific Profiles.

Scroll down and enable access to the package for the appropriate Salesforce user profiles and click on Install.

The installation could take a few minutes to finish. So give it some time and then continue in Chargebee: Settings > Third Party Integrations > Salesforce.

Step 3: Data and Configuration Validation 

In this step, Chargebee checks if certain prerequisites are met for syncing.

The following checks are done and any failures are reported:

In Chargebee 

Customer records in Chargebee are checked to see if email addresses are present.

Any records without email addresses are listed and you can either add email addresses to those records or choose to not sync those records and continue.


The email address is the default lookup-field used to match customers in Chargebee with contacts in Salesforce. You can have us change this to another field for you.

In Salesforce 

  1. Currencies are checked to ensure that all those enabled in Chargebee are also enabled in Salesforce.
  2. The Salesforce user account used to setup the integration must have access permissions to the necessary objects and their fields in Salesforce.
  3. Mandatory Custom Fields in Salesforce must be mapped to fields in Chargebee. Any unmapped ones are flagged.

Here's how you could fix some of the common errors during the validation process:

Step 4: Configure the Sync Mechanism 

Once you have reached this far in setting up the integration, it is now time to think through how Chargebee for Salesforce must be configured so that your Salesforce business workflows are supported.

Read the Integration Guide to understand the configuration options available and set them up.

Was this article helpful?