Docs

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

Quote-to-Cash Field Mapping

Note:

The Quote-to-Cash integration requires HubSpot's Sales Hub Professional edition or higher.

The integration maps Chargebee objects are mapped to some standard HubSpot objects. In the Object Mapping section you will find details mapping both at the object level and at the field level.

Object mapping

The diagram below shows the relationship between objects in HubSpot and Chargebee when using this integration. The arrows indicate the direction of data flow.

Note:

The Company-Customer mapping is primary. Contact, Deal, and Deal Line Item objects are mapped to Customer and Subscription objects in Chargebee based on the Company-Customer relationship.

Field mapping

The tables in the sections below provide the field-level mapping details for each of the HubSpot objects shown in the diagram above.

Company object field mapping

The company object in HubSpot maps to the customer object in Chargebee. The direction of data transfer on each sync is from HubSpot to Chargebee.

HubSpot Property GroupHubSpot Property (* indicates custom object)Field Mapping
Chargebee Company InformationChargebee Site Name*Subdomain name of the Chargebee site to which the customer record belongs. For example: acme-test for a TEST site or acme for a LIVE site.
Chargebee Business Entity*

This property value is used to set the following attribute in Chargebee:

customer.business_entity_id

Chargebee Customer ID

This property value is used to set the following attribute in Chargebee:

customer.id

Customer First Name

This property value is used to set the following attribute in Chargebee:

customer.first_name

Customer Last Name

This property value is used to set the following attribute in Chargebee:

customer.last_name

Email

This property value is used to set the following attribute in Chargebee:

customer.email

Company InformationCityThis property value is synced to the following attribute in Chargebee: customer.billing_address.city
Company Domain Name

This property value is synced to the following attribute in Chargebee:

Chargebee email domain

Company NameThis property value is synced to the following attribute in Chargebee: customer.company
Country / RegionThis property value is synced to the following attribute in Chargebee: customer.billing_address.country
Postal CodeThis property value is synced to the following attribute in Chargebee: customer.billing_address.zip
State/RegionThis property value is synced to the following attribute in Chargebee: customer.billing_address.state
Street AddressThis property value is synced to the following attribute in Chargebee: customer.billing_address.line1
Street Address 2This property value is synced to the following attribute in Chargebee: customer.billing_address.line2

Contact object field mapping

The contact object in HubSpot also maps to the customer object in Chargebee. The direction of data transfer on each sync is from HubSpot to Chargebee.

HubSpot Property GroupHubSpot PropertyField Mapping
Contact informationCompany Name
  • If Chargebee Primary Contact is set to Yes then the property is synced to the customer.company

  • If Chargebee Billing Contact is set to Yes then the property is synced to customer.billing_address.company.

First Name
  • If Chargebee Primary Contact is set to Yes then the property is synced to customer.first_name.

  • If Chargebee Billing Contact is set to Yes then the property is synced to customer.billing_address.first_name.

Last Name
  • If Chargebee Primary Contact is set to Yes then the property is synced to customer.last_name.

  • If Chargebee Billing Contact is set to Yes then the property is synced to customer.billing_address.last_name.

Email
  • If Chargebee Primary Contact is set to Yes then the property is synced to customer.email.

  • If Chargebee Billing Contact is set to Yes then the property is synced to customer.billing_address.email.

Phone Number
  • If Chargebee Primary Contact is set to Yes then the property is synced to customer.phone.

  • If Chargebee Billing Contact is set to Yes then the property is synced to customer.billing_address.phone.

Chargebee Contract InformationChargebee Primary Contact*

This property determines whether the contact is added as the primary contact of the customer record in Chargebee. The possible values can be:

  • Yes: When marked Yes, the contact is immediately mapped to the Chargebee customer record that is mapped to the company. Any pre-existing mapping to another contact is removed for the customer. On each sync, the properties listed in the above rows are copied over to the mapped customer record in Chargebee.

  • No: When marked No, and when this contact is mapped to a Chargebee customer, then on each sync, the Chargebee customer fields listed in the above rows are cleared.

Chargebee Billing Contact*

This property determines whether the contact is added as the billing contact of the customer record in Chargebee. The possible values can be:

  • Yes: When marked Yes, the contact is immediately mapped to the Chargebee customer record that is mapped to the company. Any pre-existing mapping to another contact is removed for the customer. On each sync, the properties listed in the above rows are copied over to the customer.billing_address record in Chargebee.

  • No: When marked No, and when this contact is mapped to a Chargebee customer, then on each sync, the Chargebee customer.billing_address fields listed in the above rows are cleared.

Note: Chargebee does not permit all the fields of customer.billing_address to be cleared at once. Consequently, if the field listed above in this table are the only fields under customer.billing_address that are populated, then they are not cleared.

Chargebee Customer ID
  • If Chargebee Primary Contact is set to Yes then the property is synced to the customer.id

  • If Chargebee Billing Contact is set to Yes then the property is synced to customer.billing_address.id.

Chargebee Site NameChargebee site name

Deal object field mapping

The Deal object in HubSpot maps to the subscription object in Chargebee. The direction of data transfer is from HubSpot to Chargebee.

HubSpot Property GroupHubSpot PropertyField Mapping
Deal InformationDeal NameBased on the preferences
Close DateBased on the subscription type
Deal ActivityPipelineBased on the preferences
Deal ActivityStageBased on the preferences
Deal RevenueAmountBased on the preferences
Deal RevenueMRRMRR is calculated by the Chargebee application and is available as subscription.mrr.
Chargebee Product Information*Chargebee Billing Cycles*The values are populated from the same properties in the Product object.

Deal Line Items object field mapping

The Deal Line Item object in HubSpot maps to the subscription object in Chargebee. The direction of data transfer is from HubSpot to Chargebee.

HubSpot Property GroupHubSpot PropertyField Mapping
TermStart date

The date at which the subscription should start. This property is applicable only for line items for which Chargebee Product Type is Plan. The value is ignored for other line items.

  • At payment: The subscription starts immediately.

  • Custom: The subscription starts on the date/time specified.

Term

This specifies the number of months the subscriptions should run before getting canceled automatically.

  • The value is always measured in months. You cannot change it to years, even if the Chargebee billing frequency is set to yearly. This limitation is due to how HubSpot manages the Term field.

  • The default value is derived from the same property in the corresponding Product object.

  • Can be modified and must be set to a value that is a multiple of the Recurring billing frequency expressed in months. For example, if the value of Recurring billing frequency is every 3 months, then the value of this property can be 3, 6, 9, and so on.

PriceRecurring billing frequency

This property is configured to the value of the same property in the Product object. You can change this value. At the time of creating a subscription or checkout link from the deal, the integration checks to see if a price point exists with this billing frequency in Chargebee. If such a price point does not exist, an error appears.

QuantityWhen Multi-Decimal Support is disabled, this property is synced to subscription.subscription_items.quantity and when enabled, it is synced to subscription.subscription_items.quantity_in_decimal.
Unit currencyThis property is configured to the same value as the deal currency. If the deal currency is not configured, then the currency configured for the HubSpot account is used.
Unit priceWhen Multi-Decimal Support is disabled, this property is synced to subscription.subscription_items.unit_price and when enabled, it is synced to subscription.subscription_items.unit_price_in_decimal.
MRRMRR is calculated by the Chargebee application and is available as subscription.mrr.
Chargebee Product Information*Chargebee Billing Cycles*The values are populated from the same properties in the Product object.

Product object field mapping

The Product object in HubSpot maps to the item family, item, and item price objects in Chargebee. The direction of data transfer is from Chargebee to HubSpot.

HubSpot Property GroupHubSpot PropertyChargebee Field
Product InformationNameitem_price.external_name
SKUThis property value is determined as the hyphen (-) separated concatenation of the following: item.id + item_price.period + item_price.period_unit.
Descriptionitem.description
URLitem.redirect_url (Applicable only when Chargebee Product Type is plan.)
PriceCurrencyitem_price.currency_code
PriceWhen Multi-Decimal Support is disabled, this is obtained from item_price.price and when enabled, this is obtained from item_price.price_in_decimal and rounded to 2 decimal places.
Unit PriceWhen Multi-Decimal Support is disabled, this is obtained from item_price.price and when enabled, this is obtained from item_price.price_in_decimal and rounded to 2 decimal places. The item_price here is that for which item_price.currency_code corresponds to the default currency of the HubSpot account.
Recurring billing frequencyThis is automatically derived from item_price.period and item_price.period.
TermTerm (Months)item_price.billing_cycles
Chargebee Product Information*Chargebee Billing Cycles*item_price.billing_cycles
Chargebee Product Family ID*item_family.id
Chargebee Product ID*item.id
Chargebee Product Type*item.type
Chargebee Site Name*Subdomain name of the Chargebee site to which the customer record belongs. Eg. acme-test for a TEST site or acme for a LIVE site.
Chargebee Subscription Type*

Indicates the billing period type for the subscription. Applicable only when Chargebee Product Type is plan. The possible values are:

  • Forever: Indicates that the subscription renews for an indefinite period.

  • Fixed: Indicates that the subscription renews for a fixed number of times before canceling.

Was this article helpful?