zChargeGroup to QPlan
This document provides information on accessing various properties of zChargeGroup using QPlan.
The following table provides information about how to access different properties using QPlan:
| Property | Type | Description | How to access using Qcharge |
|---|---|---|---|
| allowFeatureChanges | Boolean | Specifies whether or not the features of the product can be modified in the quote. | This is not available with QPlan APIs; the only way to access this is from the Product records directly, to access the product records, you may get product record id with: qplan.get('zqu__Product__c') |
| contractEffectiveDate | Date | The contract effective date for this zChargeGroup. | qnewQPlan.getAmendment().getRecord().zqu__ContractEffectiveDate__c |
| createdDate | String | The date when the zChargeGroup was initialized. | qplan.get('CreatedDate') |
| customerAcceptanceDate | Date | The customer acceptance date for this zChargeGroup. | qnewQPlan.getAmendment().getRecord().zqu__CustomerAcceptanceDate__c |
| groupID | String | The id of this charge group/rate plan. | qplan.getUniquePlanIdentifier() |
| groupType | Integer | The life cycle value of the charge group. See the available lifecycle indicator values in this table. | The original method uses a static value. You can instead check the Quote Amendment Type and Quote Subscription Type to get similar insights, see below. |
| originalChargeGroup | zqu.zChargeGroup | The original subscription charges. | qplan.getOriginalPlan() |
| productId | String | Id of the Product that this charge belongs to. | qplan.get('zqu__Product__c') |
| productName | String | The Product that was selected for creation. | qplan.get('zqu__QuoteProductName__c') |
| productRatePlanId | String | The id of the product rate plan that this charge belongs to. | qplan.get('zqu__ProductRatePlan__c') |
| productRateplanZuoraID | String | The Zuora ID of the selected product rate plan. | qplan.get('zqu__ProductRatePlanZuoraId__c') |
| productSelectorId | String | The Id of the table representing the zChargeGroup on the Product Selector page. | The original method primarily supports interaction with the legacy product selector page, this is not supported with the QPlan API |
| quote | Quote__c | The quote with which this charge group is associated. | qplan.get('zqu__Quote__c') |
| quoteProductFeatures | List <zqu__QuoteProductFeature__c> | A list of zqu__QuoteProductFeature__c sObjects related to the product of the zChargeGroup. | qplan.getFeatures() |
| ratePlanBundleId | String | If this zChargeGroup is part of a bundle, this field specifies the Id unique to that bundle instance in the quote. | qplan no longer supports bundles |
| ratePlanName | String | The product rate plan (charge group) that was selected for creation. | qplan.get('Name') |
| ratePlanOptionId | String | If this zChargeGroup is a child product in a bundle, this is the Id of the zqu__ProductRatePlanOption__c. | qplan no longer supports options. However, you may access the field with the get method: qplan.get('zqu__ProductRatePlanOption__c') |
| ratePlanOverrideRefrenceId | String | The Quote Rate Plan Id of the initially added rate plan that is being modified by the current zChargeGroup. | qplan.get('zqu__RatePlanOverrideReferenceId__c') |
| serviceActivationDate | Date | The service activation date for this zChargeGroup. | qplan.getAmendment().get('zqu__ServiceActivationDate__c') |
| specificUpdateDate | Date | The date you want this zChargeGroup to be updated. | qplan.get('zqu__SpecificUpdateDate__c') |
| subscriptionRatePlanId | String | The Zuora Id of the Subscription Rate Plan that this zChargeGroup represents. | qplan.get(zqu__SubscriptionRatePlanZuoraId__c') |
| TYPE_AMENDMENT_NEWPRODUCT | static Integer | Life cycle indicator. Charge group from the saved add product amendment for amendment quote.Value: 4 | The original method is a static value. In order to check for Quote Amendment Type, you may use the following code: qplan.getAmendment().getRecord().Type__c.equals('NewProduct') &"e.zqu__SubscriptionType__c.equals('Amend Subscription') |
| TYPE_AMENDMENT_ORIGINAL | static Integer | Life cycle indicator. Charge group and charges from the original subscription for amendment quote.Value: 3 | The original method is a static value. In order to check for Quote Amendment Type, you may use the following code: qplan.getAmendment().getRecord().Type__c.equals('Original') &"e.zqu__SubscriptionType__c.equals('Amend Subscription') |
| TYPE_AMENDMENT_REMOVEPRODUCT | static Integer | Life cycle indicator. Charge group from the saved removeproduct amendment for amendment quote.Value: 6 | The original method is a static value. In order to check for Quote Amendment Type, you may use the following code: qplan.getAmendment().getRecord().Type__c.equals('RemoveProduct') &"e.zqu__SubscriptionType__c.equals('Amend Subscription') |
| TYPE_AMENDMENT_UPDATEPRODUCT | static Integer | Life cycle indicator. Charge group from the saved update product amendment for amendment quote.Value: 5 | The original method is a static value. In order to check for Quote Amendment Type, you may use the following code: qplan.getAmendment().getRecord().Type__c.equals('UpdateProduct') &"e.zqu__SubscriptionType__c.equals('Amend Subscription') |
| TYPE_CANCELLATION_ORIGINAL | static Integer | Life cycle indication. Charge group from the original subscription for cancelation quote.Value: 11 | QPlan does not represent Cancellation amendments. You may check the Quote object directly:quote.zqu__SubscriptionType__c.equals('Cancel Subscription') |
| TYPE_PRODUCT_NEW | static Integer | Life cycle indicator. New product that can be appended to a quote.Value: 1 | The original method is a static value. In order to check for Quote Amendment Type, you may use the following code: qplan.getAmendment().getRecord().Type__c.equals('NewProduct') &"e.zqu__SubscriptionType__c.equals('New Subscription') |
| TYPE_RENEWAL_NEWPRODUCT | static Integer | Life cycle indicator. Charge group from the saved add product amendment for renewal quote.Value: 8 | The original method is a static value. In order to check for Quote Amendment Type, you may use the following code: qplan.getAmendment().getRecord().Type__c.equals('NewProduct') &"e.zqu__SubscriptionType__c.equals('Renew Subscription') |
| TYPE_RENEWAL_REMOVEPRODUCT | static Integer | Life cycle indicator. Charge group from the saved remove product amendment for renewal quote. These charges are not saved but from the original subscription.Value: 10 | The original method is a static value. In order to check for Quote Amendment Type, you may use the following code: qplan.getAmendment().getRecord().Type__c.equals('RemoveProduct') &"e.zqu__SubscriptionType__c.equals('Renew Subscription') |
| TYPE_RENEWAL_RENEWED | static Integer | Life cycle indicator. Renewed group from the original subscription for renewal quote. The one-time type charges will be skipped.Value: 7 | QPlan does not represent Renewal amendments. You may check the Quote object directly:quote.zqu__SubscriptionType__c.equals('Renew Subscription') |
| TYPE_RENEWAL_UPDATEPRODUCT | static Integer | Life cycle indicator. Charge group from the saved update product amendment for renewal quote.Value: 9 | The original method is a static value. In order to check for Quote Amendment Type, you may use the following code: qplan.getAmendment().getRecord().Type__c.equals('UpdateProduct') &"e.zqu__SubscriptionType__c.equals('Renew Subscription') |
| TYPE_SUBSCRIPTION_ADDED | static Integer | Life cycle indicator. Charge group saved in new subscription type quote.Value: 2 | QPlan does not represent NewSubscription amendments |
| zCharges | LIST<zqu.zCharges> | A list of individual zCharges in the group. | qplan.getCharges() |
The zChargeGroup class provides the following methods related to Zuora rate plans.
Method | Type | Description | How to access using Qcharge |
|---|---|---|---|
| deepClone | zChargeGroup | Clones the zChargeGroup to use it for different actions. | qplan.deepClone(Boolean preserveId) |
| getShowVisualForceDelete | Boolean | Determines whether it is possible to use the delete action on the charge group. | Method tied to Visual Force page, this is no longer supported in LWC Quote Studio |
| getShowVisualForceEdit | Boolean | Determines whether it is possible to use the editable action on the charge group. | Method tied to Visual Force page, this is no longer supported in LWC Quote Studio |
| getShowVisualForceUndelete | Boolean | Determines whether it is possible to use the un-delete action on the charge group. | Method tied to Visual Force page, this is no longer supported in LWC Quote Studio |