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.

Functionality


Description


Field Availability


Report Builder

In Report Builder, you can add any of your custom fields to create Detailed, Visual, or Summary Reports.



Image

Available as created in Chargebee
Reports Explorer(Filters)

In Reports Explorer, use the custom fields to filter default reports.



Image

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.

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

.

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,
      </strong>
      or<strong> Sales Agent</strong>).
      <span
        class="fabric-editor-annotation"
        data-mark-type="annotation"
        data-mark-annotation-type="inlineComment"
        data-id="5696421a-b82d-475e-9cca-7934f8e3adb5"
      >
        To enable this mapping
      </span>
      , contact
      <a href="https://support.chargebee.com/support/home">support</a>.
    </p>
    <br/>
    <br/>
    <img
      src="./assets/screenshots/images/rs/cs3.png"
      alt="Image"
      width="200"
      height="80"
    />
    <br/>
    <br/>
    <div
      data-node-type="mediaSingle"
      data-layout="center"
      data-width="410"
      data-width-type="pixel"
    >
      <div data-mark-type="border" data-color="#091e4224" data-size="2">
        <div
          title="Attachment"
          data-id="daa776d2-4e48-4ac1-8b71-3e485f0ce392"
          data-node-type="media"
          data-type="file"
          data-collection="contentId-3473047678"
          data-width="1600"
          data-height="1025"
          data-alt=""
          data-context-id="3473047678"
          data-file-mime-type="image/png"
          data-file-name="AD_4nXcik35Lzh6dPsPAYbjOQTeibggoz-lW38h99i7O61AqfqlhAbvL8mCaEDBXjKovfQaTlM0N34HtJXvWiHFK2W5bJ8ZIsjDNZc2-1KT3ewkFNZcFle7rMa59y_tVyeu5XIIcA62NytpirjKOXM05efeOJG96?key=kfOUUJ7B0RQZLhVAO7HCqA"
          data-file-size="200713"
        >
          &nbsp;
        </div>
      </div>
    </div>
  </td>
  <td>
    Available after mapping the custom field to a pre-defined field in
    Revenue Story.
  </td>
</tr>
<tr>
  <td>Dashboard(Filters)</td>
  <td>
    On the Dashboard, filter using custom fields by mapping [Chargebee Custom Fields](/billing/2.0/site-configuration/custom_fields) to RevenueStory Custom
    Fields; contact support to enable this mapping.
    <br/>
    <br/>
    <img
      src="./assets/screenshots/images/rs/cs4.png"
      alt="Image"
      width="200"
      height="80"
    />
    <br/>
    <br/>
  </td>
  <td>
    Available after mapping the custom field to a pre-defined field in
    RevenueStory.
  </td>
</tr>
<tr>
  <td></td>
  <td></td>
</tr>

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.

Resource

Custom Field

Type

Customer

Business Type

String

Business Vertical

String

Acquisition Cost

Long

Acquisition Channel

String

Sales Agent

String

Customer Type

String

Acquisition Mode

String

Account Manager

String

Customer Success Agent

String

Solution Partner

String

Freemium Blacklist Reason

String

Unique Customer Handle

String

Product Usage

Long

Subscription

Product Usage

Long

Sales Agent

String

Solution Partner

String

Acquisition Cost

Long

Cancel Reason

String

Plan

Plan Group

String

Addon

Addon Group

String

Was this article helpful?