Zuora CPQ metric fields mapping and derivation
Zuora CPQ metric fields are mapped and derived from the Orders Preview Metrics Response, with specific objects in the CPQ application storing billing amounts based on the preview response.
All the metrics fields listed in this document can be relied upon as a direct representation of metrics returned from the Orders Preview Metrics Response. However, there are more metrics fields in the Zuora CPQ data model that represent older, locally calculated fields that should not be relied upon to represent metrics returned from the Zuora Billing engine.
In the Zuora CPQ application, when the pricing information of the product is changed, the application gets the effective billing amount of the change from Zuora by making a call to the Preview an order API operation. After getting the response from the preview call, the metrics data of Zuora Billing is stored in the CPQ application in different objects based on the level of information. The following list includes objects in the CPQ where the billing amounts are stored from the preview response:
-
Quote (zqu__Quote__c): Stores summary information for all rate plans and charges at the parent level.
-
Quote Rate Plan Charge (zqu__QuoteRatePlanCharge__c)
-
Stores the charge information displayed in the UI.
-
Zuora CPQ does not use any metrics in this object as a reference for Billing metrics. Only the list of fields returned from the Preview an order API operation are used as a reference for any amounts in this object.
-
-
Quote Charge Summary (zqu__QuoteChargeSummary__c)
-
Stores the delta metrics as returned by the preview response.
-
Zuora CPQ references the metrics fields in this object to the
OrderMetrics
fields returned from the preview response.
-
-
Quote Charge Detail (zqu__QuoteChargeDetail__c)
-
Stores the total lifetime amount of the charge for the subscription as returned by the preview response.
-
Zuora CPQ references the metrics fields in this object to the
ChargeMetrics
returned by the preview response.
-
-
Quote Charge Interval Detail (zqu__QuoteChargeIntervalDetail__c)
-
Stores the interval level metrics of the charge for the ramp subscription as returned by the preview response.
-
Zuora CPQ references the metrics fields from in object to the
RampMetrics
fields returned by the preview response.
-
-
Quote Order Line Item (zqu__QuoteOrderLineItem__c)
-
Stores the non subscription items attached to the quote and its related metrics as returned by the preview response.
-
Zuora CPQ references the metrics fields in this object to the
Invoices
fields returned by the preview response.
-
-
Quote Ramp Interval (zqu__QuoteRampInterval__c)
-
Stores the interval level metrics for the ramp subscription as returned by the preview response.
-
Zuora CPQ references the metrics fields in this object to the
RampMetrics and Invoices
fields returned by the preview response.
-
-
Charge segment (zqu__ChargeSegment__c)
-
Stores the charge segment-level metrics like MRR, TCB, and deltas as returned by the preview response.
-
Zuora CPQ references the metrics fields in this object to the
ChargeMetrics
returned by the preview response.
-
-
Invoice Item Summary (InvoiceItemSummary__c)
-
Stores the invoice item summary-level metrics like Preview Invoice Sequence, Service Period Start Date, Service Period End Date, SubTotal Amount, Discount Amount, Tax Amount, Total Amount, Quote, and Subscription Number as returned by the preview response.
-
Zuora CPQ references the metrics fields in this object to the InvoiceItemSummary returned by the preview response.
-
In addition, you should understand the following differences between CPQ X and CPQ 9 if you are using the Zuora CPQ API:
-
Quote Studio application is built on top of the new
QPlan
data model and API. See CPQ X API for more information. -
Zuora CPQ 9 UI is built on the existing legacy zChargeGroup data model and API.
Zuora CPQ objects and Preview an Order response mapping
This section describes how metric fields on Zuora CPQ objects are mapped or derived from the fields returned from the previewResult
data block in the Preview an order response.
See the sections below for detailed information about the mapping relationships.