Getting Started

Building Blocks

Custom Fields

Subscription Features




Billing Features


Payment Methods

Direct Debit Payments

Configuring Gateways

Fraud Management

Hosted Pages


Reports and Analytics


Open Source Resources

Other Features

API Integration

Third Party Integrations



Salesforce is a CRM platform that allows you to keep track of the leads generated, deals closed, and new customers acquired.

Chargebee's integration with Salesforce will help manage customer and subscription lifecycle seamlessly.

The integration will ensure a free flow of customer and subscription details between Chargebee and Salesforce and enable teams to manage sales pipeline, accounts/contacts, pricing and discount information and close deals once the contract is finalized.

  • Available only in selected plans. To know more, visit Chargebee's Plans and Pricing page
  • Chargebee-Salesforce integration is supported only in Salesforce Enterprise Edition
  • Only one Chargebee site can be linked to a Salesforce Account.


Here's the list of checks-

In Chargebee:

  • Customer Email ID: Email ID acts as the unique identifier. Customers in Chargebee should have an email ID to sync in Salesforce. If your customers do not have an email ID, the customers will not be synced
  • If a customer in Chargebee does not have an email ID, the customer info will not be synced
  • If the same email ID is present in both Chargebee & Salesforce, the customer details will be mapped and a new Customer record will not be created
  • If two or more customers have the same email ID, it will be captured as a sync error and the sync will not go through. Removing the duplicate values will let you proceed further with the sync

In Salesforce:

  • Field access: The user logging in, while setting up the integration, should have access to necessary objects (say, Pricebook) in Salesforce. Based on the user's credentials, Chargebee will get access to the fields/objects and the details will be synced to Salesforce accordingly.

  • Mandatory field check: If a field is mandatory in Salesforce and the field is not mandatory in Chargebee (or unavailable), it will pop up as an error. You can contact  to provide a default value offline.

  • Multicurrency: Multicurrency should be enabled in both Chargebee and Salesforce.

Integrating Chargebee and Salesforce 

The integration of Salesforce and Chargebee begins with the installation of the Chargebee plugin. The plugin authenticates, validates and syncs your customer information in Salesforce and Chargebee.
During the integration, the fields in Chargebee are mapped with the fields in Salesforce (with the help of standard and custom objects).

Here's how Chargebee's data maps to Salesforce data and entities -

*These are created as Custom Objects in Salesforce. Read more about Custom Objects in Salesforce

Step 1: Connect to Salesforce

Navigate to Settings > Third Party Integrations > Salesforce, you'll find the option Connect and clicking it will redirect you to the Salesforce page asking you for your Salesforce credentials. Enter the credentials and proceed.

Step 2: Install Chargebee Plugin

After the credentials are validated, you'll now be redirected to the Chargebee app for initiating the one-time installation of the plugin.
During the installation, you will be asked to choose the Account/role the plugin needs to be linked/installed to. We recommend that you enable the plugin for Admins. You can change the plugin access for other users in Salesforce later as well.

You will be navigated back to Chargebee after the installation is completed.

  • To install the plugin, you need to subscribe to Salesforce Enterprise Edition.
  • If you run into ‘Time Out' error during the installation of the Chargebee Plugin, navigate to Chargebee site's Settings > Third Party Integrations > Salesforce, refresh the page and retry

Step 3: Validate Prerequisite checks

In this step, Chargebee checks if the prerequisites are met.

Based on the checks performed, Chargebee will list the errors, if encountered:

  • Multicurrency and field/object access-related errors need to be fixed before proceeding
  • The errors with email IDs can be fixed then or later

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

Step 4: Configure Sync Preferences

Set a Date: You need to set a date for Chargebee to pick the records and sync with Salesforce. Based on your choice, Chargebee will sync all the records from the date specified by you.
Next, define how the changes in Chargebee should be updated in Salesforce.

What happens in Chargebee You can choose what should happen in Salesforce
When a Customer is created Create a new Account
Create a new Contact for an Account
When a Subscription is created Create a Subscription and an Opportunity
Create a Subscription but don't create an Opportunity
When a Subscription is upgraded Update the existing Opportunity
Create a new Opportunity and update the probability of existing Opportunity (to 0%)
Don't update the Opportunity
When a Trial is Created or changed (from Trial to Active state) Create an Opportunity
Don't create an Opportunity

What happens in Salesforce when a new customer is created in Chargebee is defined here. The Customer details will be retained as Contact details in Salesforce along with the Company Name. There are two ways of handling new customers in Chargebee

  1. Create an Account in Salesforce: This option will create a new Account in Salesforce for every new Customer in Chargebee.
  2. Group the Customers: This option will create a Contact for an Account in Salesforce. The name of the Account will be the name of the Customer given in Chargebee.

Every Subscription in Chargebee creates a Subscription (custom object) in Salesforce.
Here's how it works:

i) Create Subscription: When a Subscription is created in Chargebee, you can choose to create a Subscription and an equivalent Opportunity in Salesforce, or just create a Subscription but not an Opportunity

ii) Upgrade Subscription: When a Subscription is updated in Chargebee, there are 3 ways of updating an Opportunity in Salesforce:

  1. The existing Opportunity can be updated
  2. Create a new Opportunity with the updated value
  3. Don't update the Opportunity in Salesforce

Subscription downgrades will not be updated to Salesforce

iii) Trial Subscriptions: When a trial subscription is created or changed, you can either create a zero value Opportunity in Salesforce or don't create an Opportunity in Salesforce. When the trial subscription is moved to active state in Chargebee, an Opportunity will be created in Salesforce.

Step 5: Run a Test Sync

Once the sync preferences are set, Chargebee will do a ‘Test Sync' with the first 10 records which were created on or from the date set by you. You could check how the sync reflects in your Salesforce account

If you encounter any errors, Chargebee will describe the nature of the error and also how to fix it. You can either resolve them and retry the sync or skip and proceed. If you choose to skip a customer record, keep in mind that the related records such as invoices, transactions will not be synced. You can always initiate a sync manually after fixing the errors with the given record.

After the test sync, you'll also find the option on Sync All Records which will initiate a sync for all records between Chargebee and Salesforce.

Manage Sync Preferences 

Auto Sync: You can enable this option to initiate a sync every 30 minutes between Chargebee and Salesforce.

Sync Now (On-demand sync): At any point in time, if there's a change in Chargebee that need to be reflected in Salesforce, Sync Now option will sync the changes made and update the same in Salesforce immediately.

Manage Preferences: This option allows you to update or change your sync preferences. The changes made will only take effect from the next sync onwards and will have no impact on the data synced previously.


You cannot change the sync start date after initial setup via your Chargebee site. Contact  to update the sync start date and re-sync.

Remove Integration: In case you want the integration to stop, this is the option to use. The link between Chargebee and Salesforce will be removed and will stop any further data from being synced until you set it up again. However, this will not affect the data which has been synced already.

Download Error Report: This option will download the error log (in a CSV format). This will help you sort the errors and prep the data again for sync.

From Salesforce to Chargebee 

Updates in your Salesforce account can be synced to your Chargebee site. Sync will take place in the background without you having to log in to your Chargebee account while working on your Salesforce Account, given Auto Sync is ON.
The following are the operations you can perform in Salesforce to sync to your Chargebee site:

Operation Description
Update Payment Method Prompts customer to update their payment method. Customers will be redirected to Chargebee's Checkout page
Create Customer in Chargebee A lead's conversion to a customer can be recorded in your Chargebee site
Create Subscription Creates a subscription for the customer in your Chargebee site

Custom Buttons In Salesforce 

After setting up the integration of Chargebee with Salesforce, you will find Custom buttons of Chargebee in your Salesforce account. These buttons can be added to your existing Salesforce layout and can perform three Chargebee Operations: ‘Update Payment Method', ‘Create Customer in Chargebee' and ‘Create Subscription'.


Lightning UI supports one-way sync alone as Salesforce does not support custom buttons in Lightning UI

You can place the buttons on the following objects in Salesforce:

  • Accounts
  • Contacts
  • Opportunities

Only certain operations can be carried out in the given objects and here's how it works:

Salesforce Object Chargebee Operation
Account Create Subscription
Contacts - Create Customer in Chargebee
- Update Payment Method
- Create Subscription
Opportunity Create Subscription

Configure Custom Buttons 

There are three Chargebee custom buttons available in Salesforce: ‘Update Payment Method', ‘Create Customer in Chargebee' and ‘Create Subscription'. Buttons for all three operations will be made available in your Salesforce account once the integration setup is done.

To configure these buttons in the Salesforce Objects, navigate to Accounts/Contacts/Opportunities in your Salesforce Account. Click on Edit Layout, and choose Button from the ‘Account/Contact/Opportunity Layout' menu. Now, you will find the buttons for Chargebee Operations. Select the operation and drag it to the 'Account/Contact/Opportunity Detail' section, into the 'Custom Buttons' box.

Save the changes.

Chargebee Operations in Salesforce 

Update Payment Method:

Payment methods and subscription are saved against a customer. Using this option you can prompt customers to update their associated payment method.

An email will be sent to the customer with the link to the checkout page where he can add the payment details.

The information will be collected in Chargebee's end. Once the payment information is filed, you can sign up for the subscription on your customer's behalf. However, if you want customers to update their payment method as well as sign up for the subscription, send them the checkout link.

If there are customers or subscriptions linked to the Account, you can send a form to the customers to enter their details, the subscriptions they opt for and their payment method. This will, in turn, create customers, link a subscription to the respective Account and create an invoice and collect payment based on the payment method he saved.

Create Subscription:

This option will create a subscription for the customer from the list of plans.

Clicking on create subscription will allow you to create a subscription for the customer from your end.

However, if you want your customer to create a subscription himself, you could use the option ‘Send Checkout Link'. This will send an email to your customer.

The checkout link included in the email will redirect the customer to the page where the Subscription details and the Customer information are pre-populated. The payment details need to be entered by the customer on this page.


Only the first subscription of the customer can be created this way.

When a Subscription is created from an Account, you will be prompted to choose a Customer and an Opportunity. Choosing a Customer is mandatory. However, if you haven't chosen an Opportunity, Chargebee will create one in Salesforce by default.

When a Customer is created from a Contact, you will be prompted to choose an Opportunity. However, if you haven't chosen one, Chargebee will create an Opportunity in Salesforce by default.

Create Customer in Chargebee:

A new customer will be created in Chargebee based on your Customer's email ID.


Is the Lightning UI framework supported?
Yes, the integration is supported by Salesforce Classic and Lightning UI frameworks.

How do I change the Sync Start Date later?
Contact  to change the Sync Start Date you had set up initially, as the option is not available in the Chargebee App.

Does Chargebee support Person Accounts?
Chargebee does not support Person Account. However, if the feature is enabled in Salesforce, Chargebee will create Accounts in Salesforce with record type as Business Accounts.

Does this integration support the record types in my Salesforce account?
Yes, records types in your Salesforce account is supported by Chargebee-Salesforce. Record types in your Salesforce account will be identified while validating the records. Contact  to set up default values for the record types.