Docs

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

Custom Fields in RevenueStory

Chargebee allows you to create custom fields for different objects (such as Customers, Subscriptions, and Items) and track additional information about them. You can create custom fields on your Chargebee site as required and use them to store custom data about these objects.

Once created, these fields can be used for richer analytics via RevenueStory in the following ways. 

Note:

  • Please note that reporting on custom fields is only available as a part of RevenueStory Premium.
  • Additionally, the automatic sync of all Chargebee custom fields within RevenueStory is not supported for consolidated sites. However, you may still use these custom fields in individual sites.
  • Only custom fields created in Customer, Subscriptions, and Items (Plans, Addons, and Charges) are currently available within RevenueStory. Custom fields created for Item Prices (Plan Prices, Addon Prices, Charge Prices)are not yet supported within RevenueStory.
FunctionalityDescriptionField Availability
Report BuilderIn Report Builder, you can add any of your custom fields to create Detailed, Visual, or Summary Reports.Available as created in Chargebee
Reports Explorer(Filters)In Reports Explorer, use the custom fields to filter default reports.Available as created in Chargebee
Reports Explorer(Variant reports)

RevenueStory has certain pre-defined fields derived from everyday use cases designed to help you access more reports based on the custom fields you create in Chargebee. more reports based on the custom fields you create in Chargebee. For example, Customer Type is a category or segmentation that you may want to explore further. As this field is not available out-of-the-box (OOTB) in Chargebee, you might store this information as a custom field in Chargebee under a different name, such as Customer Segment. When you map the custom field (Customer Segment) to the pre-defined field (Customer Type) in RevenueStory, you can view the MRR grouped by the Customer Segment in the report titled Total MRR by Customer Type. is a category or segmentation that you may want to explore further. As this field is not available out-of-the-box (OOTB) in Chargebee, you might store this information as a custom field in Chargebee under a different name, such as Customer Segment. When you map the custom field (Customer Segment) to the pre-defined field (Customer Type) in RevenueStory, you can view the MRR grouped by the Customer Segment in the report titled Total MRR by Customer Type. The following variant reports are available in RevenueStory:

  • Business Type
  • Customer Type
  • Plan Group
  • Acquisition Channel
  • Sales Agent
  • To use any of these reports, you can perform a one-time mapping of Chargebee Custom Fields to any of the Variants (Business Type, Customer Type, Plan Group, Acquisition Channel,or Sales Agent). To enable this mapping, contact support.
Available after mapping the custom field to a pre-defined field in Revenue Story.
Dashboard(Filters)On the Dashboard, filter using custom fields by mapping [link_static custom_fields.html]Chargebee Custom Fields[] to RevenueStory Custom Fields; contact support to enable this mapping.Available after mapping the custom field to a pre-defined field in RevenueStory.
  

Mapping to predefined fields in RevenueStory

Map your Chargebee Custom Fields to the following RevenueStory Custom Fields listed in the table in the previous section for the Variant Reports functionality.

ResourceCustom FieldType
CustomerBusiness TypeString
 Business VerticalString
 Acquisition CostLong
 Acquisition ChannelString
 Sales AgentString
 Customer TypeString
 Acquisition ModeString
 Account ManagerString
 Customer Success AgentString
 Solution PartnerString
 Freemium Blacklist ReasonString
 Unique Customer HandleString
 Product UsageLong
SubscriptionProduct UsageLong
 Sales AgentString
 Solution PartnerString
 Acquisition CostLong
 Cancel ReasonString
PlanPlan GroupString
AddonAddon GroupString

Articles & FAQs

Is it possible to map Chargebee custom fields into Revenuestory?

Was this article helpful?