Charge Segment fields
This document details the Charge Segment fields for usage, non-usage, and removed charges, including how these fields are populated.
The following table lists how the Charge Segment fields are populated.
| Field label and API name | Type and description |
|---|---|
|
Charge Segment Name Name |
Auto Number Unique number/name of the Charge Segment in the Salesforce System. |
|
Charge Number (zqu__ChargeNumber__c) |
Text(255) The charge number from the Zuora Billing API Order Preview response. It is the same as the charge number on QRPC/QCS. For Usage charges, this is the QRPC or QCS Id. In the case of Removals, there is only QCS and no QRPC. For removals, the Charge Number is determined based on the charge type:
|
|
Segment (zqu__Segment__c) |
Number(18,0) The Segment number per charge is ordered chronologically by Start Date. This is not the same as the segment number returned from the Billing API Order Preview response but is calculated within the Zuora Quotes managed package. It is calculated by grouping the segments by charge number and ordering them chronologically by start date. |
|
Action Type (zqu__ActionType__c) |
Text(255) A read-only text field that concatenates the related Quote Rate Plan "Quote_Amendment_Type__c" (pulled from the Quote Amendment record itself) and the Quote Rate Plan "AmendmentType__c" fields, with a tilde (~) between the fields, which looks like "QuoteRatePlan.Quote_Amendment_Type~QuoteRatePlan.AmendmentType". This field helps distinguish whether the Charge Segment is part of the Original Quote or an Add/Update/Remove action taken on the Quote. It is mostly helpful in Amendment and Renewal Quotes. Following are examples of the field text when the charge is the same (if unchanged and recurring):
|
|
Start Date (zqu__StartDate__c) |
Date Effective start date of the Charge Segment. For removals, it is the effective date of the RemoveProduct action. |
|
End Date (zqu__EndDate__c) |
Date Effective end date (inclusive) of the Charge Segment. For example, a one-year term starting 1/1/2025 would have an end date of 12/31/2025 and not 1/1/2026. For removals, the End Date is determined based on the following scenarios:
|
|
Quote (zqu__Quote__c) |
Lookup(Quote) Lookup to the Quote related to the segment. This lookup shall always exist for any segment. |
|
Quote Charge Detail (zqu__QuoteChargeDetail__c) |
Lookup(QuoteChargeDetail) Lookup to the Quote Charge Detail related to the segment. This lookup shall always exist for any segment. |
|
Quote Charge Summary (zqu__QuoteChargeSummary__c) |
Lookup(QuoteChargeSummary) Lookup to the Quote Charge Summary related to the segment. This lookup may not always exist because Quote Charge Summary is not always generated for certain Order Action types. For an explanation of Zuora Quotes objects created per Quote Type/Action Type, see Quote Object records created with Orders. |
|
Quote Rate Plan Charge (zqu__QuoteRatePlanCharge__c) |
Lookup(QuoteRatePlanCharge) Lookup to the Quote Rate Plan Charge related to the segment. This lookup may not always exist because Quote Rate Plan Charge is not always generated for certain Order Action types. For an explanation of Zuora Quotes objects created per Quote Type or Action Type, see Quote Object records created with Orders. |
|
Quote Charge Interval Detail (zqu__QuoteChargeIntervalDetail__c) |
Lookup(QuoteChargeIntervalDetail) Lookup to the Quote Charge Interval Detail related to this segment. This lookup shall only populate for segments on Ramped Quotes. There is no QCID for Usage type charges because no metrics are returned from the Zuora API for Usage charges. |
|
Quote Ramp Interval (zqu__QuoteRampInterval__c) |
Lookup(QuoteRampInterval) Lookup to the Quote Ramp Interval related to this segment. This lookup shall only populate for segments on Ramped Quotes and for all charge types. |
|
Quantity (zqu__Quantity__c) |
Number(13,5) The total quantity of the charge. |
|
Delta Quantity (zqu__DeltaQuantity__c) |
Number(13,5) The Contracted Delta Quantity of the charge. This is not the delta per charge within the term. It is not the same as Delta Quantity on QCS. This delta quantity represents the delta from the start of the subscription version from which the Quote is effective. For new quotes, the Delta Quantity is the same as the Quantity. |
|
Gross MRR (zqu__GrossMRR__c) |
Number(16,2) The segment MRR is exclusive of any discounts applicable. For more information about the MRR metric, see Monthly Recurring Revenue. |
|
Delta Gross MRR (zqu__DeltaGrossMRR__c) |
Number(16,2) The segment change in MRR between the latest segment MRR and the previous segment MRR after a subscription amendment, exclusive of any applicable discounts. |
|
Net MRR (zqu__NetMRR__c) |
Number(16,2) The segment MRR includes all the applicable discounts, including the fixed amount and percentage discounts. |
|
Delta Net MRR (zqu__DeltaNetMRR__c) |
Number(16,2) The segment change in MRR between the latest segment MRR and the previous segment MRR after a subscription amendment, including any applicable discounts. |
|
Gross TCB (zqu__GrossTCB__c) |
Number(16,2) The Total Contracted Billing , exclusive of discounts, of a segment, which represents the forecasted total amount that is billed over the entire duration of a Charge Segment at the time it is booked, signifying the total expected revenue from the Charge Segment based on their initial subscription details. |
|
Delta Gross TCB (zqu__DeltaGrossTCB__c) |
Number(16,2) The difference of a Charge Segment's TCB as a result of an Order, exclusive of discounts. |
|
Net TCB (zqu__NetTCB__c) |
Number(16,2) The TCB of a segment, including discounts, represents the forecasted total amount that will be billed over the entire duration of a Charge Segment when it is booked. This essentially signifies the total expected revenue from the Charge Segment based on its initial subscription details. |
|
Delta Net TCB (zqu__DeltaNetTCB__c) |
Number(16,2) The difference of a Charge Segment's TCB as a result of an Order, inclusive of discounts. |
Charge Segment fields - Removed charges
Removed charges are not represented in the Charge Metrics' Period Metrics. OrderMetrics is used to generate Removed Charge Segments. The following table lists how certain fields of Removed Charge Segments are populated.
|
Field label |
Description |
|---|---|
|
Charge Number |
Text In the case of Removals, there is only QCS and no QRPC. If Recurring charge type, then Charge Number is pulled from the OrderMetric > OrderAction response body. If Usage charge type, QCS Charge Number is used. If the value is null, then QCS Id is used. |
|
End Date |
Date In Ramp Quotes for a newly added product, this is the same as the end date returned in the Order Metrics for the RemoveProduct action and aligns with the Subscription Term End Date. For example, removing a newly added product would be future-dated removal of a product within the same Quote it was added. In Ramp Quotes for an Original charge, this aligns with the Interval End Date on which the removal occurs. For example, removing an existing charge on an amendment or renewal quote. In Non-Ramp Quotes for a newly added products, this is the same as the end date returned in the Order Metrics for the RemoveProduct action and aligns with the Subscription Term End Date. In Non-Ramp Quotes for an Original charge, this aligns with the Subscription Term Date (Amendment) or Renewal Subscription Term End Date (Renewals). For example, removing an existing charge on an Amendment or Renewal Quote. |
|
Start Date |
Date The effective date of the RemoveProduct action. |
Charge Segment fields - Usage charges
The following table lists how the charge segment fields are populated for usage charges.
Usage charges are billed in arrears and not at the quote generation time. Hence, the Zuora Billing APIs do not provide Usage charge metrics when previewing a Quote. Therefore, Usage type Charge Segments are specially made within the Quotes package, with the following fields and no metrics.
Field label | Description |
|---|---|
Charge Segment Name | Auto generated |
Charge Number (zqu__ChargeNumber__c) | If a QRPC created the usage record, this field is the QRPC:
in that order, depending on whether the field is populated. If QCS created the usage record, this field is the QCS:
in that order, depending on whether the field is populated. |
Segment (zqu__Segment__c) | Calculated by grouping the Segments by Charge Number and ordering them by Start Date chronologically. |
Action Type (zqu__ActionType__c) | Text(255) A read-only text field that concatenates the related Quote Rate Plan "Quote_Amendment_Type__c" (pulled from the Quote Amendment record itself) and the Quote Rate Plan "AmendmentType__c" fields, with a tilde (~) between the fields, which looks like "QuoteRatePlan.Quote_Amendment_Type~QuoteRatePlan.AmendmentType". This field helps distinguish whether the Charge Segment is part of the Original Quote or an Add/Update/Remove action taken on the Quote. It is mostly helpful in Amendment and Renewal Quotes. Following are examples of the field text when the charge is the same (if unchanged and recurring):
|
Start Date (zqu__StartDate__c) | If QRPC exists, use QRPC.EffectiveStartDate, else use QCS.DeltaTCBStartDate. If the QCS.DeltaTCBStartDate is unavailable, for example, New Quote future dated removal, then use the QuoteAmendment.CustomerAcceptanceDate. In the case of a Flat Renewal of a Usage charge when no QRPC nor QCS is available, then use the Quote.RenewalSubscriptionTermStartDate. |
End Date (zqu__EndDate__c) | If QRPC exists, use QRPC.EffectiveEndDate, else use QCS.DeltaTCBEndDate. If the QCS.DeltaTCBEndDate is unavailable, for example, New Quote future dated removal, then use the Quote.SubscriptionTermEndDate. In the case of a Flat Renewal of a Usage charge when no QRPC nor QCS is available, then use Quote.RenewalSubscriptionTermEndDate. All these end dates are calculated with a "minus 1 day" to align with the Segment's inclusive date ranges, for example, 12/31 rather than 1/1. Note: Note: In certain cases, due to an existing consideration that is planned to be fixed in a near release, when making a future dated update or removal, the previous Charge Segment's End Date does not align with the new update/removal. |
Quote (zqu__Quote__c) | Lookup to Quote record. |
Quote Charge Detail (zqu__QuoteChargeDetail__c) | Lookup to Quote Charge Detail. For Amendment Quotes, there is no QCD created and, therefore, no QCD lookup in the following cases:
|
Quote Charge Summary (zqu__QuoteChargeSummary__c) | Lookup to Quote Charge Summary. For information about when QCS is generated for certain Order Action Types, see Quote Object records created with Orders. |
Quote Rate Plan Charge (zqu__QuoteRatePlanCharge__c) | Lookup to the Quote Rate Plan Charge related to the segment. This lookup may not always exist because Quote Rate Plan Charge is not always generated for certain Order Action types. |
Original Quote Rate Plan Charge (zqu__OriginalQuoteRatePlanCharge__c) | Only populated for "Renewal~Renewal" Action Type Charge Segments that are Usage charge types within Renewal Quotes. Lookup to the Quote Rate Plan Charge related to the Original Quote Amendment on a Renewal Quote. The purpose of this lookup is to access the Quote Rate Plan Charge Tier pricing information for Volume and Tier charges. |
Quote Charge Interval Detail (zqu__QuoteChargeIntervalDetail__c) | Null. There are no QCID records created for Usage charge types. |
Quote Ramp Interval (zqu__QuoteRampInterval__c) | Lookup to Quote Ramp Interval. |
Quantity (zqu__Quantity__c) | Null |
Delta Quantity (zqu__DeltaQuantity__c) | Null |
Gross MRR (zqu__GrossMRR__c) | Null |
Delta Gross MRR (zqu__DeltaGrossMRR__c) | Null |
Net MRR (zqu__NetMRR__c) | Null |
Delta Net MRR (zqu__DeltaNetMRR__c) | Null |
Gross TCB (zqu__GrossTCB__c) | Null |
Delta Gross TCB (zqu__DeltaGrossTCB__c) | Null |
Net TCB (zqu__NetTCB__c) | Null |
Delta Net TCB (zqu__DeltaNetTCB__c) | Null |
The following is an Entity Relationship Diagram for the Charge Segment within the Zuora Quotes object model.