Charge Segment fields
This article lists the Charge Segment fields for usage and non-usage charges.
The following table lists how the Charge Segment fields are populated.
For some remove product actions and usage charges the table is not applicable.
| Field label and API name | Type and description |
|---|---|
|
Charge Segment Name |
Auto Number Unique number/name of the Charge Segment in the Salesforce System. |
|
Charge Number |
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 |
|
Segment |
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. |
|
Start Date |
Date Effective start date of the Charge Segment. |
|
End Date |
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. |
|
Quote |
Lookup(Quote) Lookup to the Quote related to the segment. This lookup shall always exist for any segment. |
|
Quote Charge Detail |
Lookup(QuoteChargeDetail) Lookup to the Quote Charge Detail related to the segment. This lookup shall always exist for any segment. |
|
Quote Charge Summary |
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 |
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 |
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 |
Number(13,5) The total quantity of the charge. |
|
Delta Quantity |
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 |
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 |
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 |
Number(16,2) The segment MRR includes all the applicable discounts, including the fixed amount and percentage discounts. |
|
Delta Net MRR |
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 |
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 |
Number(16,2) The difference of a Charge Segment's TCB as a result of an Order, exclusive of discounts. |
|
Net TCB |
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 |
Number(16,2) The difference of a Charge Segment's TCB as a result of an Order, inclusive of discounts. |
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 |
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 |
Calculated by grouping the Segments by Charge Number and ordering them by Start Date chronologically. |
|
Start Date |
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 |
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: 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 |
Lookup to Quote record. |
|
Quote Charge Detail |
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 |
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 |
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. |
|
Quote Charge Interval Detail |
Null. There are no QCID records created for Usage charge types. |
|
Quote Ramp Interval |
Lookup to Quote Ramp Interval. |
|
Quantity |
Null |
|
Delta Quantity |
Null |
|
Gross MRR |
Null |
|
Delta Gross MRR |
Null |
|
Net MRR |
Null |
|
Delta Net MRR |
Null |
|
Gross TCB |
Null |
|
Delta Gross TCB |
Null |
|
Net TCB |
Null |
|
Delta Net TCB |
Null |
The following is an Entity Relationship Diagram for the Charge Segment within the Zuora Quotes object model.
