Installation Guide 

If you have setup the Salesforce integration before 27th July 2020, it is likely that you are using an older version of the integration. To migrate to the current version, contact support .

The integration must be setup exactly as described on this page. So follow the steps carefully. Do get in touch with Chargebee support  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.

  1. On your Chargebee site, navigate to Apps > Go to Marketplace > Sales & CRM > Salesforce. Click Connect. You are redirected 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 support  or contact your Chargebee Sales or Customer Success representative to enable the integration.

  2. 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. Once the installation is successful, proceed to the next step.

Step 3: Provisioning licenses for the first time 

Follow these steps if you are setting up the Salesforce integration for the first time.

  1. Contact support  to have the licenses provisioned for your account.
  2. Wait 2-3 business days to hear back from us. (You may continue with Step 4 below while you wait.)
  3. Once you hear from us, assign the licenses  to users in Salesforce.

Step 4: Data and configuration validation 

Login to Chargebee and navigate to Apps > Go to Marketplace > Sales & CRM > Salesforce.

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 change this to another field.

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 set up 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.

Step 5: 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?