Custom Fields in RevenueStory
Custom fields created in Chargebee for entities such as customers, subscriptions, and item prices (plans, addons, and charges) can be used to filter, group, and analyze data in RevenueStory. These fields enable you to build reports and dashboards tailored to your business attributes and segmentation needs.
RevenueStory natively supports the following Chargebee custom fields. This means that once these fields are created in Chargebee, they are automatically available in RevenueStory.
Note: Custom field mapping must be done only for the plan item in Product Catalog 2.0. Please contact Chargebee Support if you would like to view the custom fields at the plan item level in RevenueStory.
Supported Resources
- Customer(Product Catalog 1.0 and Product Catalog 2.0)
- Subscription (Product Catalog 1.0 and Product Catalog 2.0)
- Plan (Product Catalog 1.0)
- Addon (Product Catalog 1.0)
- Plan Price (Product Catalog 2.0)
- Addon Price (Product Catalog 2.0)
- Charge Price (Product Catalog 2.0)
Note
- Custom field support in RevenueStory is available only on the RevenueStory Premium plan.
- Custom field mapping will have to be done for the plan item in Product Catalog 2.0. Please contact Chargebee Support if you would like to view the custom fields at the plan item level in RevenueStory.
- Custom fields are not automatically synced for consolidated sites. You can still use them within individual sites.
Supported Features
You can use Chargebee custom fields in the following RevenueStory features:
Dashboard filters Use custom fields to filter dashboards and analyze performance based on specific attributes. Once created in Chargebee, custom fields automatically appear in filter options.
Reports Explorer filters Apply custom fields as filters in built-in reports within Reports Explorer.
Report Builder Include custom fields when building summary, detailed, or visual reports.
Variant Reports In Reports Explorer RevenueStory includes a set of predefined reports called variant reports, which segment key metrics such as monthly recurring revenue (MRR), churn, and subscriber activity by business dimensions.
To access such variant reports, you must map custom fields from different resources to a set of predefined variant report dimensions.
Working with Variant Reports in Reports Explorer
Variant reports organize data using standard business dimensions. If you want to use a custom field to segment a variant report, you need to map that field to a supported dimension.
Example
If you store customer segmentation data in a custom field called segment, you can map this field to the Customer type dimension. After mapping, you can view reports such as Total MRR by Customer Type using your own segmentation data.
You can map your Chargebee custom fields to the following variant report dimensions:
- Customer Type
- Business Type
- Acquisition Channel
- Sales Agent
- Plan Group
To request a mapping:
- Identify the custom field you want to use.
- Choose the corresponding variant report dimension.
- Contact Chargebee Support to complete the mapping process.
Note
Only one custom field can be mapped to each variant dimension.
Was this article helpful?