Getting Started

Product Catalog

Customers

Subscriptions

Invoices, Credit Notes and Quotes

Taxes

Payments

Site Configuration

Data Privacy & Security

Data Operations

Reports and Analytics

Integrations

Field-Mapping 

Important
This page is for the latest version of the Salesforce integration that maps Chargebee customer records to Salesforce accounts. If you setup the Salesforce integration before 6th Jan 2020, it is likely that you are using a deprecated version of the integration that performs a contact-based mapping. To migrate to the current version, contact [email protected] .

Object-Level Mapping 

Chargebee objects are mapped to standard as well as custom objects in Salesforce . The latter are created by Chargebee. The table below shows the relationship between objects in either systems in terms of data flow.

Chargebee Object/Data

Salesforce Object

(* indicates custom object)

Customer Account
Contact
Plan/Addon

Product
CB Pricing Tier* 
Price Book Entry
Quote

CB Quote*

CB Quote Line Item*

CB Quote Product*

CB Quote Coupon*
Subscription




Opportunity

Opportunity Product

CB Opportunity Product*

CB Opportunity Coupon*

CB Subscription*

Subscription Addon*

Coupon Line Items*
Invoice CB Invoice*
CB Invoice Line Item*
Coupon CB Coupon*
Credit Note CB Credit Note*
CB Credit Note Allocation*
Chargebee site domain name

CB Site*

Field-Level Mapping for Standard Objects 

Here we look at how fields in standard Salesforce objects are mapped to data in Chargebee. The notation used to represent Chargebee data is as seen in the Chargebee backend API .

Account 

Accounts in Salesforce are mapped to customers in Chargebee. Given below is the default field-mapping.

Salesforce Field

(* indicates custom field)

Chargebee Field / Data
Account Name

Customer.company

Phone Customer.phone
Auto Collection* Customer.auto_collection
Billing Street Customer.billing_address.line1 + line2 + line3 (the field values are concatenated, separated by commas)
Billing City Customer.billing_address.city
Billing Zip/Postal Code Customer.billing_address.zip
Billing State/Province Customer.billing_address.state
Billing Country Customer.billing_address.country
Chargebee Email* Customer.email
Chargebee First Name* Customer.first_name
Chargebee Id* Customer.id
Chargebee Last Name* Customer.last_name
Chargebee Site* Lookup to CB Site object which in turn stores the domain name of the Chargebee site this account belongs to
Is Synced* Indicates that the record has been mapped to Chargebee.
Locale* Customer.locale
Net Term Days* Customer.net_term_days
Payment Method Status* Customer.payment_method.status
Payment Method Type* Customer.payment_method.type
Sync with Chargebee* Checkbox that automates data sync from the account to Chargebee whenever a change is made to the account.
Taxability* Customer.taxability
VAT Number* Customer.vat_number

Contact 

The Contact object is mapped to fields in the Customer object in Chargebee. The default mapping is given below.

Salesforce Field

(* indicates custom field)

Chargebee Field / Data

Email

Customer.email
Name (composite field) Customer.first_name, Customer.last_name
Phone Customer.phone
Preferred currency* (Deprecated)
Payment Method Status* (Deprecated)
Payment Method Type* (Deprecated)
Net Term Days* (Deprecated)
Chargebee_Modified_Time* (Deprecated)
Auto collection* (Deprecated)
Sync with Chargebee*

Checkbox that marks the contact – while it is attached to an account – as the one to consider for syncing with Chargebee.

Price Book 

A Price Book record is created for each Chargebee site that is connected to the Salesforce org. The fields used by the integration are as follows:

Salesforce Field

(* indicates custom field)

Chargebee Field / Data
CB Site* Lookup to CB Site object which in turn stores the domain name of the Chargebee site this price book belongs to.
Price Book Name

CB Price Book prefixed with the Chargebee site domain name.

Price Book Entry 

A price book entry record is created for each Chargebee plan and addon.

Salesforce Field

(* indicates custom field)

Chargebee Field/Data Comments
Product Code Plan/Addon.id
List Price Plan/Addon.price The value is set to 0 when the Recurring charge model is volume, tiered or stairstep.
Active Plan/Addon.status If Plan/Addon.status is active then true else false.
Use Standard Price Always set to false.
Currency Plan/Addon.currency_code
Setup Cost Plan.setup_cost

Product 

Each plan and addon is synced into Salesforce as a Product record.

Salesforce Field

(* indicates custom field)

Chargebee Field/Data Comments
External ID Plan/Addon.Id
Active Plan/Addon.status If Plan/Addon.status is active then true else false.
Product Name Plan/Addon.name
Product Code Plan/Addon.id
Product Currency Plan/Addon.currency_code
Trial Period* Plan.trial_period Only applicable for plans and not for addons.
Trial Period Unit* Plan.trial_period_unit Only applicable for plans and not for addons.
Bill Every* Plan/Addon.period
Bill Every Unit* Plan/Addon.period_unit
Billing Cycles* Plan.billing_cycles Only applicable for plans and not for addons.
Free Quantity* Plan.free_quantity Only applicable for plans and not for addons.
Recurring charge model* PLan/Addon.pricing_model
Price* Plan/Addon.price The value is set to 0 when the Recurring charge model is volume, tiered or stairstep.
Set Up Fee* Plan.setup_cost Only applicable for plans and not for addons.
Status* Plan/Addon.status
Product Type* The value is PLAN for plans and ADDON for addons. 
Invoice Name* Plan/Addon.invoice_name
Currency* currency_code
ChargeBee Modified Time* Time when changes to the plan/addon record were last synced to Salesforce.
Addon Type* Addon.charge_type
Addon Applicability* Plan.addon_applicability Only applicable for plans and not for addons.

Opportunity 

Opportunity records are only created or modified by the integration when some form of opportunity handling has been configured. The following opportunity fields are updated by the integration:

Salesforce Field

(* indicates custom field)

Chargebee Field/Data
CB Opportunity Type

Indicates the opportunity type in relation to Chargebee. This field is set by Chargebee and can have one of the following values:

  • New subscription: indicates that the opportunity is for creating a new subscription.
  • Renewal: indicates that the opportunity has been created via setting 4.1 for subscriptions with finite billing cycles for the renewal of their terms.
  • Upgrade/Downgrade: indicates that the opportunity has been updated using the Manage CB Products action to update an existing subscription.
Subscription Id The id of the subscription in Chargebee that the opportunity is linked to.
Update Chargebee Checkbox which determines whether a subscription should be created or updated in Chargebee when the opportunity is won.
Close Date Subscription.activated_at
Opportunity Currency Subscription.currency_code
Opportunity Name This field is set to the company name of the customer record.
Price book The Id of the price book for the Chargebee site.
Stage The stage of the opportunity may be set via the integration if configured accordingly.
Coupon* Deprecated field. The attached coupons can now be found in the CB Coupon related list for the opportunity.

Opportunity Product 

Opportunity Product records are only created or modified by the integration when some form of opportunity handling has been configured. The following opportunity product fields are updated by the integration:

Salesforce Field

(* indicates custom field)

Chargebee Field/Data Comments
Quantity

Subscription.plan_quantity

or

Subscription.addons[quantity]


Sales Price

Subscription.plan_unit_price

or

Subscription.addons[unit_price]

If the plan or addon have their pricing models as tiered, volume or stairstep, the value is set based on the tier(s), the quantity falls under.
Discount

For Chargebee plans: the discount percentage is calculated based on the plan free quantity and the coupon discount.

For Chargebee addons: the discount percentage is calculated based on the coupon discount.



Was this article helpful?
Loading…