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. Field-Mapping
  1. Billing
  3. Integrations
  5. Sales
  7. Salesforce (v1.38+)
  8. Field-Mapping

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/DataSalesforce Object (* indicates custom object)
CustomerAccount
Contact
Plan/AddonProduct
CB Pricing Tier*
Price Book Entry
QuoteCB Quote*
CB Quote Line Item*
CB Quote Product*
CB Quote Coupon*
SubscriptionOpportunity
Opportunity Product
CB Opportunity Product*
CB Opportunity Coupon*
CB Subscription*
Subscription Addon*
Coupon Line Items*
InvoiceCB Invoice*
CB Invoice Line Item*
CouponCB Coupon*
Credit NoteCB Credit Note*
CB Credit Note Allocation*
Chargebee site domain nameCB 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 [link_api]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 NameCB 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 / DataComments
Product CodePlan.id or Addon.id
List PricePlan.price or Addon.priceThe value is set to 0 when the Recurring charge model is volume, tiered or stairstep.
Use Standard PriceAlways 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_periodOnly applicable for plans.
Trial Period Unit*Plan. trial_period_unitOnly 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_typeOnly 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.

Was this article helpful?