Charge Segment creation for removed products
Due to nuances in how Order Preview response handles Charge Period metrics, Zuora CPQ manually creates Charge Segments in different ways. This article highlights the differences, the data model specifics, and how CPQ creates Charge Segments for the following scenarios of removing products.
- Recurring charges versus usage charges
- Newly added products versus existing/original products
- Ramp versus non-ramp quotes
When adding a new product onto a New, Amendment, or Renewal Quote and doing a future-dated removal, the removed product is only represented within the Order Metrics portion of the JSON response body.
When removing an original or existing product, which can only be done in an Amendment or Renewal Quote, the removed product is represented within the Charge Period metrics portion of the JSON response body.
Also, it is important to understand how Charge Period metrics define "delta metrics" because they are different from mid-quote delta metric fields, which are on the Quote Charge Summary. Charge Period metric deltas represent contractual changes. The difference from one contract, which can be considered a Quote or Zuora Subscription version, to the next is considered a contractual change. This means a Charge Period delta would appear when a Charge is removed from one subscription version to the next.
A contractual change example is removing an original charge in an Amendment or Renewal Quote.
A non-contractual change example is removing a charge within the same subscription version, like future-dated removal within a New, Amendment, or Renewal Quote.
Another critical concept to understand is the structure of the Zuora Order Preview JSON response body. Consider the following sample response and see how the different sections translate to specific metric structures so that you may understand the references in this documentation:
Charge Metrics
Charge Period Metrics
Order Metrics
Order Action Metrics
Invoice Metrics
Invoice Item Metrics
Ramp Metrics
Ramp Interval Metrics
Access the following links for a detailed description of the following scenarios for product removal Charge Segment: