Getting Started

Product Catalog



Invoices, Credit Notes and Quotes



Site Configuration

Data Privacy & Security

Data Operations

Reports and Analytics


Chargebee for Salesforce - Package Upgrade Guide 

Upgrade to Chargebee Package 1.39X

This page provides step-wise instructions, troubleshooting tips, best practices recommendations and offers tools for a successful upgrade.

  • Available for Lightning and Classic

Upgrade Process 

The entire upgrade process can be divided into two main steps:

  1. Install Package
  2. Migrate preferences

Install Package 

Upgrading the package has implications on your data, object relationships, reports, components and others.

Estimated time required
1-2 Hours (may vary based on the data volume to be synced).
It is recommended to perform the upgrade at non-business hours with lesser traffic for easy deployment.


  • Minimum requirement: Version 1.36
  • User role: System Administrator

Recommended Actions

  1. Test the new upgrades on your Sandbox
    Install and test out the new version on your sandbox before installing it on the live site. The integration does not support downgrading to the older version of the Chargebee app.

  2. Backup your Data
    Perform a full data backup if possible and turn off any triggers temporarily until the upgrade and migration completes.

  3. Turn of auto-sync


  1. Login to

  2. Reach out to [email protected]  to obtain the new package link.
    The link initiates the package installation process.

  3. On the Upgrade Chargebee for Salesforce screen, select Install for Specific Profiles and click Upgrade.

    This starts the upgrade installation.

  4. After the installation is complete, click Done.

    This redirects you to the Installed Package screen on your Salesforce org which shows the details of the package version. For more information on package installation, refer the complete installation guide.

Ensure Critical Update 

Before migrating your data, ensure that the critical update "Enable improved caching of org" is activated for the organisation.

Follow these steps to ensure that the critical update is activated:

  1. Go to Setup.

  2. On the search box on the left, search Critical Updates.

  3. Look for Enable improved caching of org on the critical update page.

  4. If the setting is not already activated, Click Activate.

Migrating Your Data 

Chargebee carefully moves your site settings, field mapping, sync preferences, configurations and data from the old version so you do not have to manually change the settings. Once migrated, the data such as product catalog data, transactional data are resynced to Salesforce.
Ensure that your sites are added as a remote site in the Remote Site Settings page.


Estimated time required: 1-2 hours

User Permission 

To perform the migration, users need to be provided with the ChargebeeForSalesforceAdminUser permissions. [Learn how to assign permission to a user]salesforce-integration-guide.html#prerequisites_assigning-permission-sets target)


  1. On Salesforce dashboard, go to Chargebee Integration, from the app switcher.
    This redirects you to migration screen.

  2. Click on Start Migration.

Once your data is migrated for your package is complete, Chargebee sends an email notification to the connected email account.


Turn on the auto-sync
If you are satisfied with the migration, you may turn the auto-sync back on.

Checklist for migration 

Task Action

Check if the user profile has access to "chargebeeapps.Sync Settings

Add the custom setting to the Enabled Custom Setting Definitions list

Check that the ChargebeeForSalesforceAdminUser Permission Set is assigned

Refer Manage Permission step

CRUD (Create,Read,Update and Delete) permission on :

  • CB Subscription

  • CB Opportunity Product

  • CB Opportunity Coupon

  • Coupon Line Item

  • Subscription Addons

  • Product

  • Price Book

  • Price Book Entry

  • Opportunity Product

Provide access.

Read and Update permission for the following field:

  • Opportunity Product

    • Discount

  • Price Book Entry:

    • List Price

    • Active

    • Price Book Name

  • Product:

    • External Id

    • Product Name

    • Product Code

Provide access

Enable activation of improved caching of org


Reach out to support 

Though the Salesforce for Chargebee app provides detailed description of the errors and their resolutions, if you are having trouble upgrading, reach out to [email protected] . You may also need to grant access to the support team in order for them to guide you better.

Steps to grant access to support 

In Salesforce Lightning

  1. Click on the profile avatar and go to Settings.

  2. Search for Grant Login Access from the search box.

  3. Set the Access Duration to 3-7 days for ChargebeeInc Support.

  4. Click Save.

In Salesforce Classic

  1. Click on the profile name.

  2. Click on My settingsPersonal

  3. Set the Access Duration to 3-7 day for ChargebeeInc Support.

  4. Click on Save.

Was this article helpful?