Docs
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 .
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* |
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 .
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 | |
| Phone | Customer.phone |
| Auto Collection* | |
| Billing Street | |
| Billing City | Customer.billing_address.city |
| Billing Zip/Postal Code | |
| Billing State/Province | |
| Billing 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* | |
| 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 |
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 |
| |
Customer.email |
| Name (composite field) | Customer.first_name, Customer.last_name |
| Phone | Customer.phone |
| Preferred currency* | |
| Payment Method Status* | |
| Payment Method Type* | |
| Net Term Days* | |
| Chargebee_Modified_Time* | |
| Auto collection* | |
| Sync with Chargebee* | Checkbox that marks the contact – while it is attached to an account – as the one to consider for syncing with Chargebee. |
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 | |
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. |
| 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. 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. |
Articles & FAQ