You are viewing:

Getting Started

Product Catalog

Customers

Hosted Capabilities

Subscriptions

Invoices, Credit Notes and Quotes

Taxes

Payments

Site Configuration

Data Privacy & Security

Data Operations

Reports and Analytics

Apps

Field-Mapping

Important
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 .

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
Customer	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*
Invoice	CB Invoice Line Item*
Coupon	CB Coupon*
Credit Note	CB Credit Note*
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.id` or `Addon.id`
List Price	`Plan.price` or `Addon.price`	The value is set to 0 when the Recurring charge model is `volume`, `tiered` or `stairstep`.
Active	`Plan.status` or `Addon.status`	If `Plan.status` or `Addon.status` is `active` then `true` else `false`.
Use Standard Price	Always set to `false`.
Currency (`chargebeeapps__Currency__c`)	`Plan.currency_code` or `Addon.currency_code`
Currency (`CurrencyIsoCode`)	(Not used)
Setup Cost*	`Plan.setup_cost`
Trial Period Unit*	`Plan.trial_period`	Only applicable for plans.
Trial Period Unit*	`Plan.trial_period_unit`	Only applicable for plans.
Bill Every*	`Plan.period` or `Addon.period`
Bill Every Unit*	`Plan.period_unit` or `Addon.period_unit`
Billing Cycles*	`Plan.billing_cycles` or `Addon.billing_cycles`
Free Quantity*	`Plan.free_quantity`	Only applicable for plans.
Recurring charge model*	`Addon.charge_type`	Only applicable for addons.
Pricing Model*	`Plan.pricing_model` or `addon.pricing_model`
Invoice Name*	`Plan.invoice_name` or `Addon.invoice_name`
Chargebee Modified Time*	Time when changes to the plan/addon record were last synced to Salesforce.
Addon Applicability*	`Plan.addon_applicability`	Only applicable for plans and not for addons.

Product

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

Salesforce Field (* indicates custom field)	Chargebee Field / Data
External ID	(Not used)
Active	(Not used)
Product Name	`Plan.name` or `Addon.name`
Product Code	`Plan.id` or `Addon.id`
Product Currency	`Plan.currency_code` or `Addon.currency_code`
Trial Period*	(Deprecated)
Trial Period Unit*	(Deprecated)
Bill Every*	(Deprecated)
Bill Every Unit*	(Deprecated)
Billing Cycles*	(Deprecated)
Free Quantity*	(Deprecated)
Recurring charge model*	(Deprecated)
Price*	(Deprecated)
Set Up Fee*	(Deprecated)
Status*	(Deprecated)
Product Type*	The value is `PLAN` for plans and `ADDON` for addons.
Invoice Name*	(Deprecated)
Currency*	(Deprecated)
ChargeBee Modified Time*	(Deprecated)
Addon Type*	(Deprecated)
Addon Applicability*	(Deprecated)

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
Amount	Sum of Totals of the Opportunity Products.
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.
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.
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
Subtotal	Sales Price x Quantity
Total	(Sales Price - Sales Price x Discount) x Quantity
Quantity	`Subscription.plan_quantity` or `Subscription.addons.quantity`
Price Book Entry	Lookup(Price Book Entry)
List price	List Price from Price Book Entry
Sales Price	`Subscription.plan_unit_price` or `Subscription.addons.unit_price`
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. By default, the integration considers all types of Chargebee coupons in the Discount calculation. However, for a given Chargebee site, if you want to exclude limited period or one-time coupons while calculating Discount, contact support@chargebee.com.
Service Period (days)*	`Subscription.event_based_addons.service_period_in_days`
Billing Cycles*	`Subscription.remaining_billing_cycles` or `Subscription.addons.remaining_billing_cycles`
Apply Charges*	`Subscription.event_based_addons.charge_once`
Addon Event*	`Subscription.event_based_addons.on_event`

Field-Level Mapping for Custom Objects

In this section, custom objects created by Chargebee in Salesforce are listed. The table in this section provides a field-level mapping between those objects and Chargebee entities. The Chargebee fields mentioned in the table are attributes of resources available in Chargebee APIv2 .

CB Subscription

CB Subscription in Salesforce is mapped to the Subscription resource in Chargebee.

Salesforce Fields	Chargebee Fields
Account	Master-Detail(Account)
Action at term end	`subscription.contract_term.action_at_term_end`
Address Line 1	`subscription.shipping_address.line1`
Address Line 2	`subscription.shipping_address.line2`
Address Line 3	`subscription.shipping_address.line3`
CB Customer Id	`subscription.customer_id`
CB Id	Concatenation of <domain name of the Chargebee site> and `subscription.id`
CB Plan Id	`subscription.subscription_items[].plan_id`
CB Site	Lookup(CB Site)
CB Subscription Id	`subscription.id`
CB Subscription Name	`subscription.id`
Chargebee Modified Time	`subscription.updated_at`
City	`subscription.shipping_address.city`
Company	`subscription.shipping_address.company`
Contact	Lookup(Contact)
Country	`subscription.shipping_address.country`
Created By	User who triggers the sync or turns on auto sync.
Currency	`subscription.currency_code`
Current Term End	`subscription.current_term_end`
Current Term Start	`subscription.current_term_start`
Due Invoices Count	`subscription.due_invoices_count`
Due Since	`subscription.due_since`
Email	`subscription.shipping_address.email`
First Name	`subscription.shipping_address.first_name`
Last Modified By	User who triggers the sync or turns on auto sync.
Last Name	`subscription.shipping_address.last_name`
MRR	`subscription.mrr`
Next billing Amount	`invoice_estimate.total`
Next billing at	`subscription.next_billing_at`
Opportunity	Lookup(Opportunity)
Phone	`subscription.shipping_address.phone`
Plan Amount	`subscription.subscription_items[].plan_amount` or `subscription.subscription_items[].plan_amount_in_decimal`
Plan Quantity	`subscription.subscription_items[].plan_quantity` or `subscription.subscription_items[].plan_quantity_in_decimal`
Plan Unit Price	`subscription.subscription_items[].plan_unit_price` or `subscription.subscription_items[].plan_unit_price_in_decimal`
.PO Number	`subscription.po_number`
Product	Lookup(Product)
Reason for cancellation	`subscription.cancel_reason`
Remaining Billing Cycles	`subscription.remaining_billing_cycles`
Resource Version	`subscription.resource_version`
Setup Fee	`subscription.setup_fee`
Site	(Deprecated)
State/ County/ Province	`subscription.shipping_address.state`
Subcription Activated At	`subscription.activated_at`
Subcription Cancelled At	`subscription.cancelled_at`
Subscription Created At	`subscription.created_at`
Subscription Id	Concatenation of <domain name of the Chargebee site> and `subscription.id`
Subscription Started At	`subscription.started_at`
Subscription status	`subscription.status`
Total Dues	`subscription.total_dues`
Trial End	`subscription.trial_end`
Trial Start	`subscription.trial_start`
Zip/ Postal Code	`subscription.shipping_address.zip`

Was this article helpful?