New in Chargebee: Explore Reveal and understand your payment performance end-to-end.Try Now
Docschargebee docs
HomeBillingPaymentsRevRecGrowthReveal
Support

Product Updates

  • Release Notes

Getting Started

  • Overview
  • Chargebee Billing Data Centers
  • Object Relationship Model
  • Understanding Sites
  • Developer Resources
  • Chargebee Tech Glossary
  • Articles and FAQ

Implementing Chargebee

  • Implementation Guide
  • Go-live Checklist
  • Articles and FAQ

AI in Chargebee

  • Chargebee Agents
  • Chargebee Copilot
  • Chargebee MCP Server (Model context protocol)

Product Catalog

  • Product Catalog Overview
  • Coupons
  • Articles and FAQ

Subscriptions

  • Working with Subscriptions
  • Billing
  • Orders
  • Articles and FAQ

Customers

  • Managing Customers
  • Account Hierarchy
  • Email Notifications
  • Branding
  • Configure Multiple Languages
  • Articles and FAQ

Invoices, Credit Notes and Quotes

  • Invoices
  • Credit Notes
  • Quotes [Legacy]
  • Transactions
  • Articles and FAQ

Taxes

  • Overview
  • Configuring Taxes
  • Country-specific Taxes
  • Articles and FAQ

Hosted Capabilities

  • Overview
  • Hosted Checkout
  • Hosted Self-Serve Portal
  • Hosted Pages Features
  • Additional Hosted Pages
  • Payment Components
  • Managing payments with ChargebeeJS
  • Mobile-Optimized Hosted Pages
  • Articles and FAQ

Site Configuration

  • Users & Roles
  • Custom Fields & Metadata
  • Mandatory Fields
  • File Attachments & Comments
  • Advanced Filter Options
  • Multicurrency Pricing
  • Multi-decimal Support
  • Configuring Reason Codes
  • Events and Webhooks
  • API Keys
  • Time Zone
  • Time Machine
  • Transfer Configurations
  • Articles and FAQ

Reports and Analytics

  • RevenueStory
  • Home Dashboard
  • Frequently Asked Questions
  • FAQs for Classic Reports Sunset
  • Articles and FAQ

Integrations

  • Sales
    • Salesforce (v1.38+)
      • Release Notes
      • Upgrading to Product Catalog 2.0
      • Upgrade and Migration Guide
      • Installation Guide
      • Integration Setup Guide
      • Chargebee Actions in Salesforce
      • Field-Mapping
    • Salesforce (v1.37)
    • HubSpot
    • Pipedrive
  • Customer Support and Success
  • Finance
  • Tax
  • Marketing
  • Stitch
  • Collaboration
  • Contract Management
  • Order Management
  • Mobile Subscriptions (Legacy)
  • Other Integrations
  • Articles and FAQ

Data Privacy & Security

  • Two Factor Authentication
  • SAML Single Sign-On
  • System for Cross-Domain Identity Management (SCIM)
  • EU-GDPR
  • Consent Management
  • Personal Data Management
  • Compliance Certificates
  • HIPAA Guidelines
  • PCI Recommendations and Integration Types
  • Articles and FAQ

Data Operations

  • Bulk Operations
  • Migration
  • Articles and FAQ
  1. Billing
  3. Integrations
  5. Sales
  7. Salesforce (v1.38+)
  8. Upgrading to Product Catalog 2.0
  1. Billing
  3. Integrations
  5. Sales
  7. Salesforce (v1.38+)
  8. Upgrading to Product Catalog 2.0

Upgrading to Product Catalog 2.0

Your Chargebee site(s) can have either Product Catalog version. Product Catalog 2.0 solves many advanced use cases and is built for scale. When you migrate your Chargebee site to Product Catalog 2.0 from 1.0, you must also migrate the Chargebee for Salesforce integration. This document details the steps to perform the migration of the integration.

Important If you are using the Salesforce package version below 1.38, and you wish to migrate your Chargebee site from Product Catalog 1.0 to 2.0, you must first upgrade the package and then migrate your site.

Note

If you have multiple Chargebee sites connected to the Salesforce instance, you can migrate all of them together or each site independently to Product Catalog 2.0 as per your business requirements.

Prerequisites

Perform the following steps before migrating your Chargebee for Salesforce to Product Catalog 2.0:

Warning

To ensure data integrity, perform the steps below in the order specified.

  1. Upgrade to the latest version of Salesforce package. Contact support for assistance with the installation.
  2. Migrate the Chargebee site(s) to Product Catalog 2.0.
  3. Optionally, modify the Product records in Salesforce to avoid creating duplicate records.

Performing the migration

The migration is performed in two stages. The first stage migrates the Chargebee's Product Catalog data in Salesforce to 2.0. The second stage updates the CB Subscriptions, CB Coupons, and CB Invoices records in Salesforce to their Product Catalog 2.0 versions.

Avoiding duplicates in product objects during migration

During the migration of your Chargebee site to Product Catalog 2.0, the plans and addons would be converted into items, and item prices. As part of stage 1, the items are mapped to products in Salesforce. Before you begin stage 1, you have the option of adjusting the product records so that new records are not created.

  1. Consider an item in Chargebee.
  2. Identify the product record in Salesforce that it should sync to.
  3. Edit the product record such that the following fields match:
    • Product Code <> item.id
    • product.product type <> item.type
    • product.CB Item Family <> item.item_family_id
  4. During stage 1, since the above fields match, the item records are mapped to existing product fields, thereby avoiding duplicate product records.

Stage 1: Migrating the Product Catalog

Follow the steps below to migrate the Product Catalog in Salesforce to 2.0:

  1. Sign in to your Salesforce account.

    image

  2. Click App Launcher and type Chargebee for Salesforce in the search box.

  3. On the Chargebee for Salesforce, click Chargebee Settings/Chargebee Integration > Post-Update Scripts/Migration.

  4. For each Chargebee Domain listed, click Check to verify the Migration Status.

    image
    For the domains that require migration of the integration, a Run button is displayed as shown in the below screenshot.

  5. Click Run to initiate the migration. This migrates the Product and Pricebook Entry records in Salesforce to their Product Catalog 2.0 versions. Additionally, the CB Item Price, and the CB Pricing Tier objects are created in Salesforce.

    image

  6. The Migration Status and its Details are displayed. If the Migration Status shows Partial Success or Failed, click View Errors to see the error details.

    image

  7. After fixing the errors, click Retry to attempt migration of products and pricebook entries again.

Note

Any Product, Pricebook Entry, and Opportunity Line Item records that were not migrated are not deleted by the migration job.

Stage 2: Migrating other objects

Once the migration of the Product Catalog has been completed, the next stage updates the existing CB Subscriptions, CB Coupons, and CB Invoices records in Salesforce to their Product Catalog 2.0 versions. Proceed as follows to complete the migration:

  1. If the Migration Status shows Success or Partial Success, then click Sync Now to update the existing CB Subscriptions, CB Coupons, and CB Invoices records in Salesforce to their Product Catalog 2.0 versions. The Migration Status changes to In Progress while the sync runs.
  2. Once the job is finished, the Migration Status changes to Success, Partial Success, or Failed.

Note

  • Running Sync Now does not create any new records. New records are only created during the regular integration sync.
  • CB Quotes are not migrated. You must create a new quote.

Migration Statuses

Listed below are the possible values of the Migration Status shown under the Migration tab of the integration configuration page.

Migration StatusDescription for Stage 1Description for Stage 2
Not required

This status indicates one of the following:

  • The site is currently using Product Catalog 1.0.
  • The site and the Salesforce integration for it have been migrated to Product Catalog 2.0.
Not applicable
RequiredThe Chargebee site is already migrated to Product Catalog 2.0. However, the Salesforce integration is yet to be migrated. When in this status, the integration sync for the specific site is disabled.Not applicable
In ProgressThis status is shown during the migration when plans, addons, charges, and their price points are being synced.The CB Subscriptions, CB Coupons, and CB Invoices records are being updated to Product Catalog 2.0.
FailedOne or more plans, addons, or charges, failed to sync.The job updating the CB Subscriptions, CB Coupons, and CB Invoices records failed such that no records were updated.
Partial SuccessAll the plans, addons, and charges were synced successfully. However, there were errors while syncing one or more price points.One or more CB Subscriptions, CB Coupons, or CB Invoices records failed to update to Product Catalog 2.0.
SuccessAll the plans, addons, charges, and their price points were synced successfully.This status is shown when all CB Subscriptions, CB Coupons, and CB Invoices records have been updated to Product Catalog 2.0.
CompletedNot applicable.This status is displayed on refreshing the page after a Partial Success or Success status.

Actions restricted during migration

This section enumerates the restrictions in effect via the Salesforce integration while performing the migration from Product Catalog 1.0 to 2.0.

Restrictions during stage 1

This section lists the restrictions that are in effect while performing stage 1 of migration. Migration Status: Required, In Progress, or Failed

The following actions are not permitted during stage 1 when the Migration Status is Required, In Progress, or Failed:

  • Creating a subscriptionfrom an account
  • Create/amend a subscription from an opportunity
  • Amending a subscription from CB Subscription
  • Manage CB Products
  • Add/Create a charge for a subscription
  • Add charge for a subscription
  • Cancel a subscription
  • Convert a quote
  • Sync a quote to an opportunity

Migration Status: Success or Partial Success The following table lists the actions that are permitted/not permitted during stage 1 when the Migration Status is either Success or Partial Success:

PermittedNot Permitted
  • Changing Sync Rules
  • Create quote for a new subscription
  • Create quote for one-time charges
  • Other quote actions such as Send email for the above two quotes
  • Creating a new subscription from an opportunity
  • Creating a new subscription using Manage CB Products
  • All actions performed from an Account that are not related to subscription. For example:
    • Create/Update Chargebee Customer
    • Invoice Unbilled Charges
  • Create quote for amending a subscription
  • Amending a subscription from an opportunity
  • Amending a subscription from CB Subscription
  • Amending a subscription using Manage CB Products
  • Running the sync manually or enabling auto-sync
  • Retrieve past data

Restrictions during stage 2

This section lists the restrictions that are in effect while performing stage 2 of migration.

Migration Status: Success or Completed

When the Migration Status during stage 2 is Success or Completed, all actions are allowed since the migration has been fully completed successfully.

Migration Status: Partial Success

When the Migration Status during stage 2 is Partial Success, all actions are allowed. However, if there are issues encountered during a subscription amendment action due to some records not being updated, an error is shown.

Migration Status: Failed

PermittedNot Permitted
  • Changing Sync Rules
  • Create quote for a new subscription
  • Create quote for one-time charges
  • Other quote actions such as Send email for the above two quotes
  • Creating a new subscription from an opportunity
  • Creating a new subscription using Manage CB Products
  • All actions performed from an Account that are not related to subscription. For example:
    • Create/Update Chargebee Customer
    • Invoice Unbilled Charges
  • Create quote for amending a subscription
  • Amending a subscription from an opportunity
  • Amending a subscription from CB Subscription
  • Amending a subscription using Manage CB Products
  • Running the sync manually or enabling auto-sync
  • Retrieve past data

Was this article helpful?