Getting Started

Building Blocks

Subscription Features

Custom Fields

Localization

Invoices

Credits

Order Management

Billing Features

Taxes

Payment Methods

Direct Debit Payments

Configuring Gateways

Revenue Recovery

Checkout

Self-Serve Portal

Notifications

Reports and Analytics

Data Privacy & Security

Fraud Management

Migration

Other Features

Developers

Third Party Integrations

Salesforce: Field-Mapping 

Object-Level Mapping 

Chargebee objects are mapped to some of the standard Salesforce objects. Moreover, some custom objects are also created in Salesforce and data from Chargebee is mapped to them too. The table below gives more detail of the mapping relationship between objects in Chargebee and Salesforce.

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*
CB Contact Site*
Chargebee Config*

Field-Level Mapping for Standard Objects 

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

Salesforce Field Chargebee Fields
Account Name

Company name in the customer record in Chargebee.

Contact 

The Contact object is mapped to fields in the Customer object in Chargebee.

Salesforce Field

(* indicates custom field)

Chargebee Field/Data

Email

Customer.email
Name Customer.first_name, Customer.last_name
Phone Customer.phone
MailingStreet Customer.billing_address.line1 + line2 + line3 (the field values are concatenated, separated by commas)
MailingCity Customer.billing_address.city
MailingState Customer.billing_address.state
MailingCountry Customer.billing_address.country
MailingPostalCode Customer.billing_address.zip
Preferred currency* Customer.preferred_currency_code
Payment Method Status* Customer.payment_method.status
Payment Method Type* Customer.payment_method.type
Net Term Days* Customer.net_term_days
Chargebee_Modified_Time* Customer.updated_at
Auto collection* Customer.auto_collection

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* Domain name of the Chargebee site
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.
Bill Every* Plan/Addon.period
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
Trial Period Unit* Plan.trial_period_unit Only applicable for plans and not for addons.
Bill Every Unit* Plan/Addon.period_unit
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
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 This is set based on the Subscription.status field value.
Coupon* Stores the reference to the CB Coupon record for the applied coupon.

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 + coupon discount.

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



Was this article helpful?
Loading…