How to configure Enrichment in Chargebee Retention?

Modified on: Fri, 16 Dec, 2022 at 5:18 PM


How to configure Enrichment in Chargebee Retention?

How to align Chargebee Billing fields in Chargebee Retention?

How to add custom fields in Chargebee Retention?


You can map the Chargebee Billing fields to Chargebee Retention by navigating to Settings > Setup > Field Mapping in Chargebee Retention


Chargebee Retention's Enrichment integration with Chargebee Billing allows you to pull in fields from your Chargebee Billing and map them to fields in Retention for use in personalization, targeting, and data segmentation. Once you have connected your Chargebee API keys, you will have fields auto-mapped into Retention. Chargebee Retention will match sessions to subscription_IDs in Chargebee Billing and pull back the relevant fields from the subscription and customer records. 

Once you have successfully connected the Chargebee integration, you will be able to select fields by field type from Chargebee Billing under Retention > Settings > Setup > Field Mapping.

You can map multiple fields as per your requirements. Mapped fields can be used to personalize the cancel page, target the cancel experience/offers, and in reporting via the customer's page.

Standard Fields Mapped from Chargebee

When you connect the Chargebee Billing to Retention, we will automatically enable Enrichment and map a set of Fields from Billing into Retention. 

The fields we pull from Chargebee are as follows:

Chargebee Retention FieldChargebee Billing Field
Organization NameCustomer Company Name
Owner First NameCustomer First Name
Owner Last NameCustomer Last Name
Owner EmailCustomer Email
StateCustomer State
CountryCustomer Country
Billing IDCustomer ID
Plan IDPlan Id
Plan IntervalBilling Period Unit
Interval LengthBilling Period
QuantityPlan Quantity
Subscription Create DateSubscription Create Date
Subscription Current Period StartSubscription Current Term Start
Subscription Current Period EndSubscription Current Term End
Subscription Start DateSubscription Start Date
Subscription Trial Start DateSubscription Trial Start Date
Subscription Trial End DateSubscription Trial End Date
Subscription Unit AmountPlan Unit Price
Subscription MRRSubscription MRR
Coupon IDsApplied Coupon Ids
Coupon CodesApplied Coupon Codes
Customer Create DateCustomer Create Date
Customer TypeCustomer Type
Plan AmountPlan Amount
Subscription AmountSubscription Amount

Example Chargebee payload

"subscription.started_at" : "1970-01-01T00:00:00Z", 
"subscription.customer.company_name" : "Chargebee",
"" : "premium_snack_pack",
"subscription.activated_at" : "1970-01-01T00:00:00Z",
"subscription.created_at" : "1970-01-01T00:00:00Z",
"subscription.customer.last_name" : "Chargebee",
"subscription.plan_quantity" : 1,
"subscription.plan_unit_price" : 99,
"subscription.mrr" : 99,
"subscription.billing_period_unit" : "MONTH",
"subscription.billing_period" : 1,
"subscription.customer.created_at" : "1970-01-01T00:00:00Z",
"subscription.plan_id" : "cbdemo_prem_s_p",
"" : "",
"subscription.plan_amount" : 99000,
"subscription.customer.first_name" : "Jane", "" : "cb_janebb"
Note: If you wish to map additional fields, reach out to us at 

Related Articles

What are the core billing features of Chargebee Retention? 

What is Chargebee Retention? 

How to Integrate Chargebee Retention and Chargebee Billing?

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.