Docs

Log in to read the version of docs relevant to your site, or use the dropdown versions

Custom field mapping in Salesforce

Scope

Field-level mapping for custom objects.

Summary

Field mapping is one of the most important steps as it creates a bidirectional linkage between the two systems and thereby gives greater control on the implications of the native salesforce settings.

If you are migrating your Chargebee site from Product Catalog 1.0 to 2.0, the Salesforce integration package cannot be readily migrated. Contact support@chargebee.com to perform the migration.

The tables provide a field-level mapping between the custom objects and Chargebee entities. The Chargebee fields mentioned in the tables are attributes of resources available in Chargebee APIv2 .

CB Item Price

CB Item Price in Salesforce is mapped to the Item Price resource in Chargebee.

Salesforce Field

(* indicates custom field)

Chargebee Field/Data
Trial Period Unittrial_period_unit
Trial Periodtrial_period
Statusstatus
Resource versionresource_version
Productname
Pricing Modelpricing_model
Price BookLookup to a Price Book record corresponding to the Chargebee site that the Item Price belongs to.
Priceprice
Period Unitperiod_unit
Periodperiod
Free Quantityfree_quantity
External Idid
Currencycurrency_code
CB Item Price Namename
Billing Cyclesbilling_cycles

CB Subscription CB Subscription in Salesforce is mapped to the Subscription

resource in Chargebee.

Salesforce FieldsChargebee Fields
AccountMaster-Detail(Account)
Action at term endsubscription.contract_term.action_at_term_end
Address Line 1subscription.shipping_address.line1
Address Line 2subscription.shipping_address.line2
Address Line 3subscription.shipping_address.line3
CB Customer Idsubscription.customer_id
CB Id"domain name of the Chargebee site"+"subscription.id"
CB Plan Idsubscription.subscription_items[].item_price_id of the plan.
CB SiteLookup(CB Site)
CB Subscription Idsubscription.id
CB Subscription Namesubscription.id
Chargebee Modified Timesubscription.updated_at
Citysubscription.shipping_address.city
Companysubscription.shipping_address.company
ContactLookup(Contact)
Countrysubscription.shipping_address.country
Created ByUser who triggers the sync or turns on auto sync.
Currencysubscription.currency_code
Current Term Endsubscription.current_term_end
Current Term Startsubscription.current_term_start
Due Invoices Countsubscription.due_invoices_count
Due Sincesubscription.due_since
Emailsubscription.shipping_address.email
First Namesubscription.shipping_address.first_name
Last Modified ByUser who triggers the sync or turns on auto sync.
Last Namesubscription.shipping_address.last_name
MRRsubscription.mrr
Next billing Amountinvoice_estimate.total
Next billing atsubscription.next_billing_at
OpportunityLookup(Opportunity)
Phonesubscription.shipping_address.phone
Plan Amountsubscription.subscription_items[].amount or subscription.subscription_items[].amount_in_decimal  of the plan.
Plan Quantitysubscription.subscription_items[].quantity or subscription.subscription_items[].quantity_in_decimal of the plan.
Plan Unit Pricesubscription.subscription_items[].unit_price or subscription.subscription_items[].unit_price_in_decimal of the plan.
.PO Numbersubscription.po_number
ProductLookup(Product)
Reason for cancellationsubscription.cancel_reason
Remaining Billing Cyclessubscription.remaining_billing_cycles
Resource Version 
Resource Versionsubscription.resource_version Site(Deprecated) State/ County/ Provincesubscription.shipping_address.state Subcription Activated Atsubscription.activated_at Subcription Cancelled Atsubscription.cancelled_at Subscription Created Atsubscription.created_at Subscription Id"domain name of the Chargebee site"+"subscription.id" Subscription Started Atsubscription.started_at Subscription statussubscription.status Total Duessubscription.total_dues Trial Endsubscription.trial_end Trial Startsubscription.trial_start Zip/ Postal Codesubscription.shipping_address.zip

Was this article helpful?