Docs

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.

<tr style="background-color:LightGray;">
  <th>
    Functionality
    <br />
  </th>
  <th>
    Description
    <br />
  </th>
  <th>
    Field Availability
    <br />
  </th>
</tr>

<tr>
  <td>Report Builder</td>
  <td>
    In <span mid="link_static"><a href="revenuestory-reportbuilder.html" target="_blank">Report Builder</a>&nbsp;<span class="fa fa-external-link text-muted"></span></span>, you
    can add any of your custom fields to create Detailed, Visual, or Summary
    Reports.
    <br />
    <br />
    <img
      src="./assets/screenshots/images/rs/cs1.png"
      alt="Image"
      width="200"
      height="80"
    />
    <br />
    <br />
  </td>
  <td>Available as created in Chargebee</td>
</tr>
<tr>
  <td>Reports Explorer(Filters)</td>
  <td>
    In <span mid="link_static"><a href="reports-explorer.html" target="_blank">Reports Explorer</a>&nbsp;<span class="fa fa-external-link text-muted"></span></span>, use the custom
    fields to filter default reports.
    <br />
    <br />
    <img
      src="./assets/screenshots/images/rs/cs2.png"
      alt="Image"
      width="200"
      height="80"
    />
    <br />
    <br />
  </td>
  <td>Available as created in Chargebee</td>
</tr>
<tr>
  <td>Reports Explorer(Variant reports)</td>
  <td class="pm-table-cell-content-wrap" data-colwidth="541">
    <p>
      <span class="fabric-text-color-mark" data-text-custom-color="#36b37e">
        RevenueStory has certain pre-defined fields derived from everyday
        use cases designed to help you
        <span
          class="fabric-editor-annotation"
          data-mark-type="annotation"
          data-mark-annotation-type="inlineComment"
          data-id="88445146-2074-4070-af55-ec5355c19a14"
        >
          access
        </span>
        more reports based on the custom fields you create in Chargebee.
      </span>
    </p>
    <p>
      For example,
      <strong>
        <span
          class="fabric-editor-annotation"
          data-mark-type="annotation"
          data-mark-annotation-type="inlineComment"
          data-id="f77d9efe-7c09-4176-8942-22a811d63229"
        >
          Customer Type
        </span>
      </strong>
      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
      <span
        class="fabric-editor-annotation"
        data-mark-type="annotation"
        data-mark-annotation-type="inlineComment"
        data-id="f77d9efe-7c09-4176-8942-22a811d63229"
      >
        might
      </span>
      store this information as a custom field in Chargebee under a
      different name, such as Customer Segment. When you map the custom
      field (
      <strong>
        <span
          class="fabric-editor-annotation"
          data-mark-type="annotation"
          data-mark-annotation-type="inlineComment"
          data-id="f77d9efe-7c09-4176-8942-22a811d63229"
        >
          Customer Segment
        </span>
      </strong>
      ) to the pre-defined field (
      <strong>
        <span
          class="fabric-editor-annotation"
          data-mark-type="annotation"
          data-mark-annotation-type="inlineComment"
          data-id="f77d9efe-7c09-4176-8942-22a811d63229"
        >
          Customer Type
        </span>
      </strong>
      ) in RevenueStory, you can view the MRR grouped by the
      <strong>
        <span
          class="fabric-editor-annotation"
          data-mark-type="annotation"
          data-mark-annotation-type="inlineComment"
          data-id="f77d9efe-7c09-4176-8942-22a811d63229"
        >
          Customer Segment
        </span>
      </strong>
      in the report titled
      <strong>
        <span
          class="fabric-editor-annotation"
          data-mark-type="annotation"
          data-mark-annotation-type="inlineComment"
          data-id="f77d9efe-7c09-4176-8942-22a811d63229"
        >
          Total MRR by Customer Type
        </span>
      </strong>
      .
    </p>
    <p>The following variant reports are available in RevenueStory:</p>
    <ul class="ak-ul">
      <li>
        <p>
          <span
            class="fabric-editor-annotation"
            data-mark-type="annotation"
            data-mark-annotation-type="inlineComment"
            data-id="e2a192f6-d96c-44da-bfb0-6e1a289c6b72"
          >
            Business Type
          </span>
        </p>
      </li>
      <li>
        <p>
          <span
            class="fabric-editor-annotation"
            data-mark-type="annotation"
            data-mark-annotation-type="inlineComment"
            data-id="e2a192f6-d96c-44da-bfb0-6e1a289c6b72"
          >
            Customer Type
          </span>
        </p>
      </li>
      <li>
        <p>
          <span
            class="fabric-editor-annotation"
            data-mark-type="annotation"
            data-mark-annotation-type="inlineComment"
            data-id="e2a192f6-d96c-44da-bfb0-6e1a289c6b72"
          >
            Plan Group
          </span>
        </p>
      </li>
      <li>
        <p>
          <span
            class="fabric-editor-annotation"
            data-mark-type="annotation"
            data-mark-annotation-type="inlineComment"
            data-id="e2a192f6-d96c-44da-bfb0-6e1a289c6b72"
          >
            Acquisition Channel
          </span>
        </p>
      </li>
      <li>
        <p>
          <span
            class="fabric-editor-annotation"
            data-mark-type="annotation"
            data-mark-annotation-type="inlineComment"
            data-id="e2a192f6-d96c-44da-bfb0-6e1a289c6b72"
          >
            Sales Agent
          </span>
        </p>
      </li>
    </ul>
    <p>
      To use any of these reports, you can perform a one-time mapping of
      Chargebee Custom Fields to any of the Variants
      <strong>

        (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 <span mid="link_static"><a href="custom_fields.html" target="_blank">Chargebee Custom Fields</a>&nbsp;<span class="fa fa-external-link text-muted"></span></span> 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](custom_fields.html) 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?
Loading…