Skip to main content

Charge Segment

Zuora

Charge Segment

  1. Last updated
  2. Save as PDF

Overview

The Charge Segment object represents the metrics for a charge's lifetime across terms for a specific period represented per charge, per interval, and discounts applied. The Charge Segment in the Quotes object model is available for Standard Quoting from Quotes version 10.38 onwards and for Multi Subscription Quoting from Quotes version 10.40 onwards.

The Zuora Order Preview API response returns additional metrics representing charge-level granularity for each charge’s segment behavioral change throughout its life within the subscription. Once a Quote is saved, these metrics are translated into the Charge Segment object. For more information, see Charge Segment behavior. 

This is an Early Adopter feature, which you can use as we continue to enhance its functionalities in future releases. If you have questions or feedback for this feature, create a Zendesk support ticket.

Prerequisites

  • Ensure that Orders is enabled to use Charge Segment metrics.
  • Ensure that Zuora Billing property "SPLIT_SEGMENT_BY_TERM" is enabled to populate the correct segment-level metrics in renewal quotes. Contact Zuora Support to check or change this Zuora Billing property setting.

Zuora does not recommend generating charge segments with Prorate recurring charges for partial periods set to FALSE, as this will generate charge totals different from what the customer is invoiced.

Enable Charge Segment

Follow these steps to enable the Charge Segment. 

  1. Navigate to Zuora Config > Quote Studio Settings > Admin Config.
  2. Click the Enable Charge Segment Metrics toggle to enable Charge Segments for your Salesforce org and click Save.
    To enable Charge Segments for MSQ, click the Enable Charge Segment Metrics toggle under the Multi-Subscription Quoting column.

Limitations and other considerations

Following are some of the known behaviors that we do not intend to change in future releases:

  • Charge segments do not support enhanced or account-level discounts, so if you use these discounts, you can not use charge segment metrics.
  • Charge segments do not include TCV metrics, as these are not returned per segment in the Zuora API response.
  • Quote Charge Detail objects are not created for usage charges for Amendment Quotes. Therefore, the segments created representing the original usage charges have no Quote Charge Detail lookup reference.
  • Unchanged usage charges in Renewal Quotes do not have a QRPC created for the renewal. Therefore, the QRPC related to the unchanged usage Charge Segments is the QRPC of the original usage charge, and the dates within that QRPC reflect the original subscription term and not the renewal term.

Following are some of the known issues that we plan to resolve in future releases:

  • Compatibility of Charge Segments with Custom Action Plugin and Extensibility Framework are not yet supported.
  • Discount charge types do not generate Charge Segments at this time. Until then, to determine the total applied Discount amount for a Charge Segment, the following calculation may be done for any MRR or TCB metric:
    Discount = Gross - Net
  • If a Quote is amended after a charge is removed, for example, the Amendment Quote Start Date is after the Removal Effective Date, the Charge Segments should not be created to represent the removed charge segments. However, these Charge Segments on Amendment Quote types are currently made for Recurring and Usage charges. This will be fixed in future releases.
  • For MSQ, when the Use Charge Segment metrics to populate Charge Level metrics in Amendment and Renewal Quotes setting is turned on, Charge Subtotals for Terms and Conditions updates are not shown in the charge table.