Docs

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

CPQ Integration Field Mapping

Object mapping

The Chargebee for CPQ integration maps Chargebee objects to both standard and custom objects in Salesforce CPQ.

The following table shows the object mapping between Chargebee and Salesforce CPQ standard and custom objects. Data flows from Salesforce to Chargebee.

Chargebee ObjectSalesforce Object (* indicates custom object)
CustomerAccount
Contact
ItemProduct
Item FamilyChargebee Product Family *
Item PricePrice Book Entry
SubscriptionSubscription
Order Product
Quote Line
InvoicesOrder Product
Quote Line
N/ASite * (A standalone object that contains the Chargebee site details.)

Field mapping for Salesforce standard objects

The tables in this section provide field-level mapping details for each Salesforce CPQ standard object.

Product

Products in Salesforce map to items in Chargebee.

Salesforce Standard Field (* indicates custom field)API NameChargebee Field
Billing Frequency *SBQQ__BillingFrequency__cPicklist
Billing Type *SBQQ__BillingType__cPicklist
Block Pricing Field *SBQQ__BlockPricingField__cPicklist
Charge Type *SBQQ__ChargeType__cPicklist
Chargebee ID *Chargebee_ID__citem.id
Chargebee Item *Chargebee_Item__cLookup(Product)
Product CodeProductCodeitem.id
Product DescriptionDescriptionitem.description
Product FamilyFamilyitem.item_family_id
Product NameNameitem.name

Price book entry

Price book entry in Salesforce maps to item prices in Chargebee.

Salesforce Standard Field (* indicates custom field)API NameChargebee Field
Chargebee ID *Chargebee_ID__citem_price.id
Chargebee Site ID *Chargebee_Site_ID__cDomain name of the Chargebee site
Created ByCreatedByIdLookup(User)
List PriceUnitPriceitem_price.price
Price BookPricebook2IdLookup(Price Book)
ProductProduct2IdLookup(Product)
Product CodeProduct2Iditem_price.id

Account

Accounts in Salesforce map to customers in Chargebee. The following table shows the default field mapping.

Salesforce Field (* indicates custom field)API NameChargebee Field
Account NameNamecustomer.id
Account NumberAccountNumbercustomer.id
Account OwnerOwnerIdLookup(User)
Auto Collection *Auto_Collection__cCustomer.auto_collection
Billing AddressBillingAddressCustomer.billing_address.line1 + line2 + line3 (the field values are concatenated, separated by commas)
Chargebee Billing contact *Chargebee_Billing_contact__cLookup to a contact that is used to populate billing contact details in sales driven automations.
Chargebee ID *Chargebee_ID_cCustomer.id
Chargebee Primary Contact *Chargebee_Primary_Contact_cLookup(Contact)
Chargebee Site ID *Chargebee_Site_ID_cDomain name of the Chargebee site
Created ByCreatedByIdLookup(User)
Last Modified ByLastModifiedByIdLookup(User)
Locale *Locale_cCustomer.locale
Net Term Days *Net_Term_Days__cCustomer.net_term_days

Contact

Contacts in Salesforce are mapped to customers in Chargebee. The following table depicts the default field mapping.

Salesforce Field (* indicates custom field)API NameChargebee Field
Account NameAccountIdLookup(Account)
EmailEmailCustomer.email
PhonePhoneCustomer.phone

Quote line

Quote lines in Salesforce map to invoices and subscriptions in Chargebee.

Salesforce Standard Field (* indicates custom field)API NameChargebee Field
Additional Disc.SBQQ__AdditionalDiscount__csubscription.discount
Additional Disc. (%)SBQQ__AdditionalDiscountPercentage__csubscription.discount_percentage
Billing FrequencySBQQ__BillingFrequency__cPicklist
Billing TypeSBQQ__BillingType__cPicklist
Block PriceSBQQ__BlockPrice__cLookup(Block Price)

Order product

Order products in Salesforce map to invoices in Chargebee.

Salesforce Standard Field (* indicates custom field)API NameChargebee Field
Account *SBQQ__Account__cLookup(Account)
Additional Disc. (%) *SBQQ__Discount__c

subscription.discount

_type.percentage

Additional Disc. (Amt) *SBQQ__AdditionalDiscountAmount__c

subscription.discount

_type.fixed_amount

Billing Frequency *SBQQ__BillingFrequency__cPicklist
Billing Type *SBQQ__BillingType__cPicklist
Charge Type *SBQQ__ChargeType__cPicklist
Chargebee ID *Chargebee_ID__csubscription.id
Chargebee Site ID *Chargebee_Site_ID__cDomain name of the Chargebee site
Contract *SBQQ__Contract__cLookup(Contract)
Created ByCreatedByIdLookup(User)
Net PriceSBQQ__NetPrice__c

subscription.subscription

_items.amount

Order ProductSBQQ__OrderProduct__cLookup(Order Product)
Product *SBQQ__Product__cLookup(Product)
Quote Line *SBQQ__QuoteLine__cLookup(Quote Line)
Quote Line Action at Term EndSBQQ__QuoteLine__c.SBQQ__Quote__c.Action_at_term_end__c

subscription.contract

_term.action_at_term_end

Quote Line Cancellation Cutoff PeriodSBQQ__QuoteLine__c.SBQQ__Quote__c.Cancellation_cutoff_period__c

Subscription.contract

_term.cancellation_cutoff_period

Quote Line Billing Cycle on RenewalSBQQ__QuoteLine__c.SBQQ__Quote__c.Billing_cycle_on_renewal__c

subscription.contract

_term_billing_cycle_on_renewal

Quantity *SBQQ__OrderProduct__c.Quantitysubscription.subscription_items.quantity
Quote Line Charge OnceSBQQ__QuoteLine__c.Charge_Once__csubscription.subscription_items.charge_once
Quote Line Charge On EventSBQQ__QuoteLine__c.Charge_On_Event__csubscription.subscription_items.charge_on_event
Order Product Chargebee TypeSBQQ__OrderProduct__c.Product2.Chargebee_Type__csubscription.subscription_items.item_type
Order Product List PriceSBQQ__OrderProduct__c.SBQQ__QuoteLine__r.SBQQ__ListPrice__csubscription.subscription_items.unit_price
Subscription Pricing *SBQQ__SubscriptionPricing__cPicklist
Subscription Start Date *SBQQ__SubscriptionStartDate__csubscription.started_date
Term Discount Schedule *SBQQ__TermDiscountSchedule__cLookup(Discount Schedule)
Terminated Date *SBQQ__TerminatedDate__csubscription.cancelled_at

Subscription

Subscriptions in Salesforce map to subscriptions in Chargebee.

Salesforce Standard Field (* indicates custom field)API NameChargebee Field
Account *SBQQ__Account__cLookup(Account)
Additional Disc. (%) *SBQQ__Discount__c

subscription.discount

_type.percentage

Additional Disc. (Amt) *SBQQ__AdditionalDiscountAmount__c

subscription.discount

_type.fixed_amount

Billing Frequency *SBQQ__BillingFrequency__cPicklist
Billing Type *SBQQ__BillingType__cPicklist
Charge Type *SBQQ__ChargeType__cPicklist
Chargebee ID *Chargebee_ID__csubscription.id
Chargebee Site ID *Chargebee_Site_ID__cDomain name of the Chargebee site
Contract *SBQQ__Contract__cLookup(Contract)
Created ByCreatedByIdLookup(User)
Net PriceSBQQ__NetPrice__c

subscription.subscription

_items.amount

Order ProductSBQQ__OrderProduct__cLookup(Order Product)
Product *SBQQ__Product__cLookup(Product)
Quote Line *SBQQ__QuoteLine__cLookup(Quote Line)
Quote Line Action at Term EndSBQQ__QuoteLine__c.SBQQ__Quote__c.Action_at_term_end__c

subscription.contract

_term.action_at_term_end

Quote Line Cancellation Cutoff PeriodSBQQ__QuoteLine__c.SBQQ__Quote__c.Cancellation_cutoff_period__c

Subscription.contract

_term.cancellation_cutoff_period

Quote Line Billing Cycle on RenewalSBQQ__QuoteLine__c.SBQQ__Quote__c.Billing_cycle_on_renewal__c

subscription.contract

_term_billing_cycle_on_renewal

Quantity *SBQQ__OrderProduct__c.Quantitysubscription.subscription_items.quantity
Quote Line Charge OnceSBQQ__QuoteLine__c.Charge_Once__csubscription.subscription_items.charge_once
Quote Line Charge On EventSBQQ__QuoteLine__c.Charge_On_Event__csubscription.subscription_items.charge_on_event
Order Product Chargebee TypeSBQQ__OrderProduct__c.Product2.Chargebee_Type__csubscription.subscription_items.item_type
Order Product List PriceSBQQ__OrderProduct__c.SBQQ__QuoteLine__r.SBQQ__ListPrice__csubscription.subscription_items.unit_price
Subscription Pricing *SBQQ__SubscriptionPricing__cPicklist
Subscription Start Date *SBQQ__SubscriptionStartDate__csubscription.started_date
Term Discount Schedule *SBQQ__TermDiscountSchedule__cLookup(Discount Schedule)
Terminated Date *SBQQ__TerminatedDate__csubscription.cancelled_at

Field-level mapping for custom objects

The table in this section provides field-level mapping details for each Salesforce CPQ custom object.

Chargebee product family

The Chargebee product family in Salesforce maps to item family in Chargebee.

Salesforce Standard FieldAPI NameChargebee Field
Chargebee ID *Chargebee_ID__citem_family.id
Chargebee Product Family NameNameitem_family.name
Chargebee Site ID *Chargebee_Site_ID__cSites that are synced with the Item family
Created ByCreatedByIdLookup(User)
Description *Description__citem_description
Last Modified ByLastModifiedByIdLookup(User)
OwnerOwnerIdLookup(User,Group)

Was this article helpful?