Custom field mapping in Salesforce : Chargebee Help Center

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 Unit	`tial_period_unit`.
Trial Period	`trial_period`
Status	`status`
Resource version	`resource_version`
Product	`name`
Pricing Model	`pricing_model`
Price Book	Lookup to a Price Book record corresponding to the Chargebee site that the Item Price belongs to.
Price	`price`
Period Unit	`period_unit`
Period	`period`
Free Quantity	`free_quantity`
External Id	`id`
Currency	`currency_code`
CB Item Price Name	`name`
Billing Cycles	`billing_cycles`

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	"<domain name of the Chargebee site>"+"`subscription.id`"
CB Plan Id	`subscription.subscription_items[].item_price_id` of the plan.
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[].amount or subscription.subscription_items[].amount_in_decimal` of the plan.
Plan Quantity	`subscription.subscription_items[].quantity or` `subscription.subscription_items[].quantity_in_decimal` of the plan.
Plan Unit Price	`subscription.subscription_items[].unit_price or` `subscription.subscription_items[].unit_price_in_decimal` of the plan.
.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`
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	"<domain name of the Chargebee site>"+"`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`

Knowledge center

Custom field mapping in Salesforce

CB Item Price

CB Subscription

Related Articles