zuora-sdk-js 3.6.0 → 3.7.0

package/docs/PreviewOrderChargeOverride.md

@@ -28,7 +28,7 @@ Name | Type | Description | Notes
 **start_date** | [**TriggerParams**](TriggerParams.md) |  | [optional] 
 **unique_token** | **String** | Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.  For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the charge. Then when you update the product, you can use the same unique identifier to specify which charge to modify.  | [optional] 
 **validity_period_type** | [**ValidityPeriodType**](ValidityPeriodType.md) |  | [optional] 
-**tax_code** | **String** | The taxCode of a charge. This field is available when the field `taxable` is set to true.   | [optional] 
+**tax_code** | **String** | The taxCode of a charge. This field is available when the field `taxable` is set to true.  | [optional] 
 **tax_mode** | [**TaxMode**](TaxMode.md) |  | [optional] 
 **taxable** | **Boolean** |  The flag to indicate whether the charge is taxable. If this field is set to true, both the fields `taxCode` and `taxMode` are required.  | [optional] 
 

package/docs/PreviewOrderChargeUpdate.md

@@ -5,15 +5,15 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **billing** | [**BillingUpdate**](BillingUpdate.md) |  | [optional] 
-**charge_number** | **String** | The number of the charge to be updated. The value of this field is inherited from the `subscriptions` > `orderActions` > `addProduct` > `chargeOverrides` > `chargeNumber` field.  | [optional] 
+**charge_number** | **String** | The number of the charge to be updated. The value of this field is inherited from the `subscriptions` > `orderActions` > `addProduct` > `chargeOverrides` > `chargeNumber` field. | [optional] 
 **product_rate_plan_charge_number** | **String** | Number of a product rate-plan charge for this subscription. | [optional] 
 **product_rate_plan_charge_id** | **String** | ID of a product rate-plan charge for this subscription.  | [optional] 
 **custom_fields** | **{String: Object}** | Container for custom fields of a Rate Plan Charge object.  | [optional] 
 **description** | **String** |  | [optional] 
 **estimated_start_date** | **String** | Estimated start date of the charge. This field is only available when the charge is changed through the related order actions. **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/\" target=\"_blank\">Pending Charge Flexibility</a> feature is enabled.  | [optional] 
 **effective_date** | [**TriggerParams**](TriggerParams.md) |  | [optional] 
-**prepaid_quantity** | **Number** | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.  The number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).        | [optional] 
+**prepaid_quantity** | **Number** | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.   The number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).       | [optional] 
 **pricing** | [**PreviewOrderPricingUpdate**](PreviewOrderPricingUpdate.md) | Pricing information about the charge.  | [optional] 
-**unique_token** | **String** | A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan charge. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan charge and use that token in future order actions.  | [optional] 
+**unique_token** | **String** | A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan charge. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan charge and use that token in future order actions. | [optional] 
 
 

package/docs/PreviewOrderCreateSubscription.md

@@ -5,17 +5,17 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **bill_to_contact_id** | **String** | The ID of the bill-to contact associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
-**invoice_separately** | **Boolean** | Specifies whether the subscription appears on a separate invoice when Zuora generates invoices.  | [optional] 
+**invoice_separately** | **Boolean** | Specifies whether the subscription appears on a separate invoice when Zuora generates invoices. | [optional] 
 **invoice_template_id** | **String** | The ID of the invoice template associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
 **new_subscription_owner_account** | [**PreviewOrderSubscriptionOwnerAccount**](PreviewOrderSubscriptionOwnerAccount.md) |  | [optional] 
 **notes** | **String** | Notes about the subscription. These notes are only visible to Zuora users.  | [optional] 
-**payment_term** | **String** | The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
+**payment_term** | **String** | The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.   **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. | [optional] 
 **sequence_set_id** | **String** | The ID of the sequence set associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
 **sold_to_contact_id** | **String** | The ID of the sold-to contact associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
 **ship_to_contact_id** | **String** | The ID of the ship-to contact associated with the subscription.  | [optional] 
 **subscribe_to_rate_plans** | [**[PreviewOrderRatePlanOverride]**](PreviewOrderRatePlanOverride.md) | List of rate plans associated with the subscription.  | [optional] 
 **subscription_number** | **String** | Subscription number of the subscription. For example, A-S00000001.  If you do not set this field, Zuora will generate the subscription number.  | [optional] 
-**subscription_owner_account_number** | **String** | Account number of an existing account that will own the subscription. For example, A00000001.  If you do not set this field or the `newSubscriptionOwnerAccount` field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the `newSubscriptionOwnerAccount` field.  | [optional] 
+**subscription_owner_account_number** | **String** | Account number of an existing account that will own the subscription. For example, A00000001.   If you do not set this field or the `newSubscriptionOwnerAccount` field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the `newSubscriptionOwnerAccount` field. | [optional] 
 **invoice_owner_account_number** | **String** | Account number of an existing account that will own the invoice. For example, A00000001. If you do not set this field, the account that owns the order will also own this invoice.  | [optional] 
 **terms** | [**PreviewOrderCreateSubscriptionTerms**](PreviewOrderCreateSubscriptionTerms.md) |  | [optional] 
 **communication_profile_id** | **String** | The ID of the communication profile associated with the subscription.  **Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature enabled.  | [optional] 

package/docs/PreviewOrderPricingUpdate.md

@@ -4,17 +4,17 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**charge_model_data** | [**ChargeModelDataOverride**](ChargeModelDataOverride.md) | Container for charge model configuration data.  **Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.  | [optional] 
+**charge_model_data** | [**ChargeModelDataOverride**](ChargeModelDataOverride.md) | Container for charge model configuration data.   **Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information. | [optional] 
 **discount** | [**DiscountPricingUpdate**](DiscountPricingUpdate.md) | Pricing information about a discount charge.  | [optional] 
-**recurring_flat_fee** | [**RecurringFlatFeePricingUpdate**](RecurringFlatFeePricingUpdate.md) | Pricing information about a recurring charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.  | [optional] 
-**recurring_per_unit** | [**RecurringPerUnitPricingUpdate**](RecurringPerUnitPricingUpdate.md) | Pricing information about a recurring charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased.  | [optional] 
-**recurring_tiered** | [**RecurringTieredPricingUpdate**](RecurringTieredPricingUpdate.md) | Pricing information about a recurring charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.  | [optional] 
-**recurring_volume** | [**RecurringVolumePricingUpdate**](RecurringVolumePricingUpdate.md) | Pricing information about a recurring charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.  | [optional] 
-**usage_flat_fee** | [**UsageFlatFeePricingUpdate**](UsageFlatFeePricingUpdate.md) | Pricing information about a usage charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.  | [optional] 
-**usage_overage** | [**UsageOveragePricingUpdate**](UsageOveragePricingUpdate.md) | Pricing information about a usage charge that uses the \"overage\" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed.  | [optional] 
-**usage_per_unit** | [**UsagePerUnitPricingUpdate**](UsagePerUnitPricingUpdate.md) | Pricing information about a usage charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit consumed.  | [optional] 
-**usage_tiered** | [**UsageTieredPricingUpdate**](UsageTieredPricingUpdate.md) | Pricing information about a usage charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed.  | [optional] 
-**usage_tiered_with_overage** | [**UsageTieredWithOveragePricingUpdate**](UsageTieredWithOveragePricingUpdate.md) | Pricing information about a usage charge that uses the \"tiered with overage\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier.  | [optional] 
-**usage_volume** | [**UsageVolumePricingUpdate**](UsageVolumePricingUpdate.md) | Pricing information about a usage charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed.  | [optional] 
+**recurring_flat_fee** | [**RecurringFlatFeePricingUpdate**](RecurringFlatFeePricingUpdate.md) | Pricing information about a recurring charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price. | [optional] 
+**recurring_per_unit** | [**RecurringPerUnitPricingUpdate**](RecurringPerUnitPricingUpdate.md) | Pricing information about a recurring charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased. | [optional] 
+**recurring_tiered** | [**RecurringTieredPricingUpdate**](RecurringTieredPricingUpdate.md) | Pricing information about a recurring charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased. | [optional] 
+**recurring_volume** | [**RecurringVolumePricingUpdate**](RecurringVolumePricingUpdate.md) | Pricing information about a recurring charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased. | [optional] 
+**usage_flat_fee** | [**UsageFlatFeePricingUpdate**](UsageFlatFeePricingUpdate.md) | Pricing information about a usage charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price. | [optional] 
+**usage_overage** | [**UsageOveragePricingUpdate**](UsageOveragePricingUpdate.md) | Pricing information about a usage charge that uses the \"overage\" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed. | [optional] 
+**usage_per_unit** | [**UsagePerUnitPricingUpdate**](UsagePerUnitPricingUpdate.md) | Pricing information about a usage charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit consumed. | [optional] 
+**usage_tiered** | [**UsageTieredPricingUpdate**](UsageTieredPricingUpdate.md) | Pricing information about a usage charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. | [optional] 
+**usage_tiered_with_overage** | [**UsageTieredWithOveragePricingUpdate**](UsageTieredWithOveragePricingUpdate.md) | Pricing information about a usage charge that uses the \"tiered with overage\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier. | [optional] 
+**usage_volume** | [**UsageVolumePricingUpdate**](UsageVolumePricingUpdate.md) | Pricing information about a usage charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed. | [optional] 
 
 

package/docs/PreviewOrderRatePlanOverride.md

@@ -6,11 +6,11 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **charge_overrides** | [**[PreviewOrderChargeOverride]**](PreviewOrderChargeOverride.md) | List of charges associated with the rate plan.  | [optional] 
 **clearing_existing_features** | **Boolean** | Specifies whether all features in the rate plan will be cleared.  | [optional] 
-**custom_fields** | **{String: Object}** | Container for custom fields of the Rate Plan object. The custom fields of  the Rate Plan object are used when rate plans are subscribed.  | [optional] 
-**product_rate_plan_id** | **String** | Internal identifier of the product rate plan that the rate plan is based on.  | [optional] 
+**custom_fields** | **{String: Object}** | Container for custom fields of the Rate Plan object. The custom fields of  the Rate Plan object are used when rate plans are subscribed. | [optional] 
+**product_rate_plan_id** | **String** | Internal identifier of the product rate plan that the rate plan is based on. | [optional] 
 **product_rate_plan_number** | **String** | Number of a product rate plan for this subscription.  | [optional] 
-**subscription_product_features** | [**[CreateOrderRatePlanFeatureOverride]**](CreateOrderRatePlanFeatureOverride.md) | List of features associated with the rate plan. The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows: * If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared. * If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.  | [optional] 
-**unique_token** | **String** | Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.  For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.  | [optional] 
+**subscription_product_features** | [**[CreateOrderRatePlanFeatureOverride]**](CreateOrderRatePlanFeatureOverride.md) | List of features associated with the rate plan.  The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:  * If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.  * If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan. | [optional] 
+**unique_token** | **String** | Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.   For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify. | [optional] 
 **subscription_rate_plan_number** | **String** | Number of a subscription rate plan for this subscription.  | [optional] 
 
 

package/docs/PreviewOrderRatePlanUpdate.md

@@ -4,14 +4,14 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**charge_updates** | [**[PreviewOrderChargeUpdate]**](PreviewOrderChargeUpdate.md) | Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action.  When previewing an `updateProduct` order action, either the `chargeNumber` or `uniqueToken` field is required to specify the charge to update.  | [optional] 
+**charge_updates** | [**[PreviewOrderChargeUpdate]**](PreviewOrderChargeUpdate.md) | Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action.   When previewing an `updateProduct` order action, either the `chargeNumber` or `uniqueToken` field is required to specify the charge to update. | [optional] 
 **clearing_existing_features** | **Boolean** | Specifies whether all features in the rate plan will be cleared.  | [optional] 
-**custom_fields** | **{String: Object}** | Container for custom fields of the Rate Plan object. The custom fields of  the Rate Plan object are used when rate plans are subscribed.  | [optional] 
+**custom_fields** | **{String: Object}** | Container for custom fields of the Rate Plan object. The custom fields of  the Rate Plan object are used when rate plans are subscribed. | [optional] 
 **product_rate_plan_number** | **String** | Number of a product rate plan for this subscription.  | [optional] 
-**rate_plan_id** | **String** | The id of the rate plan to be updated. It can be the latest version or any history version id.  | [optional] 
+**rate_plan_id** | **String** | The id of the rate plan to be updated. It can be the latest version or any history version id. | [optional] 
 **specific_update_date** | **String** |  The date when the Update Product order action takes effect. This field is only applicable if there is already a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd.  See [Update a Product on Subscription with Future-dated Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates) for more information about this feature.  | [optional] 
-**subscription_product_features** | [**[CreateOrderRatePlanFeatureOverride]**](CreateOrderRatePlanFeatureOverride.md) | List of features associated with the rate plan. The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows: * If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared. * If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.  | [optional] 
+**subscription_product_features** | [**[CreateOrderRatePlanFeatureOverride]**](CreateOrderRatePlanFeatureOverride.md) | List of features associated with the rate plan.  The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:  * If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.  * If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan. | [optional] 
 **subscription_rate_plan_number** | **String** | Number of a rate plan for this subscription.  | [optional] 
-**unique_token** | **String** | A unique string to represent the rate plan in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan and use that token in future order actions.  | [optional] 
+**unique_token** | **String** | A unique string to represent the rate plan in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan and use that token in future order actions. | [optional] 
 
 

package/docs/PreviewOrderResponse.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
 **request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
 **reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
-**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **preview_result** | [**PreviewOrderResult**](PreviewOrderResult.md) |  | [optional] 
 
 

package/docs/PreviewOrderResult.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **credit_memos** | [**[PreviewOrderResultCreditMemos]**](PreviewOrderResultCreditMemos.md) | This field is only available if you have the Invoice Settlement feature enabled. | [optional] 
 **invoices** | [**[PreviewOrderResultInvoices]**](PreviewOrderResultInvoices.md) |  | [optional] 
 **order_delta_metrics** | [**PreviewOrderResultDeltaMetrics**](PreviewOrderResultDeltaMetrics.md) |  | [optional] 
-**order_metrics** | [**[PreviewResultOrderMetricsInner]**](PreviewResultOrderMetricsInner.md) | **Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders). The new methodologies are reflected in the following Order Delta Metrics objects.   * [Order Delta Mrr](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Mrr)  * [Order Delta Tcv](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcv)  * [Order Delta Tcb](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcb)   It is recommended that all customers use the new [Order Delta Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics). If you are an existing [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders) customer and want to migrate to Order Delta Metrics, submit a request at [Zuora Global Support](https://support.zuora.com/).   Whereas new customers, and existing customers not currently on [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders), will no longer have access to Order Metrics, existing customers currently using Order Metrics will continue to be supported.  | [optional] 
-**ramp_metrics** | [**[OrderRampMetrics]**](OrderRampMetrics.md) | **Note**: This field is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information coming October 2020.  The ramp metrics.  | [optional] 
+**order_metrics** | [**[PreviewResultOrderMetricsInner]**](PreviewResultOrderMetricsInner.md) | **Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders). The new methodologies are reflected in the following Order Delta Metrics objects.    * [Order Delta Mrr](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Mrr)   * [Order Delta Tcv](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcv)   * [Order Delta Tcb](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcb)    It is recommended that all customers use the new [Order Delta Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics). If you are an existing [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders) customer and want to migrate to Order Delta Metrics, submit a request at [Zuora Global Support](https://support.zuora.com/).    Whereas new customers, and existing customers not currently on [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders), will no longer have access to Order Metrics, existing customers currently using Order Metrics will continue to be supported. | [optional] 
+**ramp_metrics** | [**[OrderRampMetrics]**](OrderRampMetrics.md) | **Note**: This field is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information coming October 2020.   The ramp metrics. | [optional] 
 
 

package/docs/PreviewOrderSubscriptionOwnerAccount.md

@@ -5,32 +5,32 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **account_number** | **String** | Account number. For example, A00000001.  | [optional] 
-**additional_email_addresses** | **String** | List of additional email addresses to receive emailed invoices. Values should be a comma-separated list of email addresses.  | [optional] 
+**additional_email_addresses** | **String** | List of additional email addresses to receive emailed invoices. Values should be a comma-separated list of email addresses. | [optional] 
 **allow_invoice_edit** | **Boolean** | Indicates if associated invoices can be edited. Values are:   * `true` * `false` (default)  | [optional] 
-**auto_pay** | **Boolean** | Specifies whether future payments are automatically billed when they are due.  | [optional] 
-**batch** | **String** | Name of the billing batch that the account belongs to. For example, Batch1.  | [optional] 
-**bill_cycle_day** | **Number** | Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as \"AutoSet\".  | 
+**auto_pay** | **Boolean** | Specifies whether future payments are automatically billed when they are due. | [optional] 
+**batch** | **String** | Name of the billing batch that the account belongs to. For example, Batch1. | [optional] 
+**bill_cycle_day** | **Number** | Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as \"AutoSet\". | 
 **bill_to_contact** | [**OrderCreateAccountContact**](OrderCreateAccountContact.md) |  | 
-**communication_profile_id** | **String** | Internal identifier of the communication profile that Zuora uses when sending notifications to the account's contacts.  | [optional] 
+**communication_profile_id** | **String** | Internal identifier of the communication profile that Zuora uses when sending notifications to the account's contacts. | [optional] 
 **credit_card** | [**CreditCard**](CreditCard.md) |  | [optional] 
-**credit_memo_template_id** | **String** | **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.  The unique ID of the credit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b.  | [optional] 
+**credit_memo_template_id** | **String** | **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.   The unique ID of the credit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b. | [optional] 
 **crm_id** | **String** | External identifier of the account in a CRM system.  | [optional] 
 **currency** | **String** | ISO 3-letter currency code (uppercase). For example, USD.  | 
 **custom_fields** | **{String: Object}** | Container for custom fields of an Account object.  | [optional] 
 **customer_service_rep_name** | **String** | Name of the account's customer service representative, if applicable.  | [optional] 
-**debit_memo_template_id** | **String** | **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.  The unique ID of the debit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2.  | [optional] 
-**hpm_credit_card_payment_method_id** | **String** | The ID of the payment method associated with this account. The payment method specified for this field will be set as the default payment method of the account.  If the `autoPay` field is set to `true`, you must provide the credit card payment method ID for either this field or the `creditCard` field, but not both.  For a specified credit card payment method, it is recommended that [the support for stored credential transactions](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Stored_credential_transactions) for this payment method is already enabled.  | [optional] 
-**invoice_delivery_prefs_email** | **Boolean** | Specifies whether to turn on the invoice delivery method 'Email' for the new account.  Values are:   * `true` (default). Turn on the invoice delivery method 'Email' for the new account. * `false`. Turn off the invoice delivery method 'Email' for the new account.           | [optional] 
-**invoice_delivery_prefs_print** | **Boolean** | Specifies whether to turn on the invoice delivery method 'Print' for the new account. Values are:   * `true`. Turn on the invoice delivery method 'Print' for the new account. * `false` (default). Turn off the invoice delivery method 'Print' for the new account.  | [optional] 
-**invoice_template_id** | **String** | Internal identifier of the invoice template that Zuora uses when generating invoices for the account.  | [optional] 
+**debit_memo_template_id** | **String** | **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.   The unique ID of the debit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2. | [optional] 
+**hpm_credit_card_payment_method_id** | **String** | The ID of the payment method associated with this account. The payment method specified for this field will be set as the default payment method of the account.   If the `autoPay` field is set to `true`, you must provide the credit card payment method ID for either this field or the `creditCard` field,  but not both.   For a specified credit card payment method, it is recommended that [the support for stored credential transactions](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Stored_credential_transactions) for this payment method is already enabled. | [optional] 
+**invoice_delivery_prefs_email** | **Boolean** | Specifies whether to turn on the invoice delivery method 'Email' for the new account.   Values are:    * `true` (default). Turn on the invoice delivery method 'Email' for the new account.  * `false`. Turn off the invoice delivery method 'Email' for the new account.          | [optional] 
+**invoice_delivery_prefs_print** | **Boolean** | Specifies whether to turn on the invoice delivery method 'Print' for the new account.  Values are:    * `true`. Turn on the invoice delivery method 'Print' for the new account.  * `false` (default). Turn off the invoice delivery method 'Print' for the new account. | [optional] 
+**invoice_template_id** | **String** | Internal identifier of the invoice template that Zuora uses when generating invoices for the account. | [optional] 
 **name** | **String** | Account name.  | 
 **notes** | **String** | Notes about the account. These notes are only visible to Zuora users.  | [optional] 
 **parent_id** | **String** | Identifier of the parent customer account for this Account object. Use this field if you have <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy\" target=\"_blank\">Customer Hierarchy</a> enabled. | [optional] 
-**payment_gateway** | **String** | The payment gateway that Zuora uses when processing electronic payments and refunds for the account. If you do not specify this field or if the value of this field is null, Zuora uses your default payment gateway.  | [optional] 
+**payment_gateway** | **String** | The payment gateway that Zuora uses when processing electronic payments and refunds for the account. If you do not specify this field or if the value of this field is null, Zuora uses your default payment gateway. | [optional] 
 **payment_method** | [**CreateAccountPaymentMethod**](CreateAccountPaymentMethod.md) |  | [optional] 
-**payment_term** | **String** | Name of the payment term associated with the account. For example, \"Net 30\". The payment term determines the due dates of invoices.  | [optional] 
-**purchase_order_number** | **String** | The number of the purchase order associated with this account. Purchase order information generally comes from customers.  | [optional] 
-**sales_rep** | **String** | The name of the sales representative associated with this account, if applicable.  | [optional] 
+**payment_term** | **String** | Name of the payment term associated with the account. For example, \"Net 30\". The payment term determines the due dates of invoices. | [optional] 
+**purchase_order_number** | **String** | The number of the purchase order associated with this account. Purchase order information generally comes from customers. | [optional] 
+**sales_rep** | **String** | The name of the sales representative associated with this account, if applicable. | [optional] 
 **sold_to_contact** | [**OrderCreateAccountContact**](OrderCreateAccountContact.md) |  | [optional] 
 **tax_info** | [**TaxInfo**](TaxInfo.md) |  | [optional] 
 

package/docs/PreviewOrderSubscriptions.md

@@ -8,6 +8,6 @@ Name | Type | Description | Notes
 **order_actions** | [**[PreviewOrderOrderAction]**](PreviewOrderOrderAction.md) | The actions to be applied to the subscription. Order actions will be stored with the sequence when it was provided in the request. | [optional] 
 **quote** | [**QuoteObjectFields**](QuoteObjectFields.md) |  | [optional] 
 **ramp** | [**CreateRamp**](CreateRamp.md) |  | [optional] 
-**subscription_number** | **String** | Leave this field empty to represent new subscription creation, or specify a subscription number to update an existing subscription.  | [optional] 
+**subscription_number** | **String** | Leave this field empty to represent new subscription creation, or specify a subscription number to update an existing subscription. | [optional] 
 
 

package/docs/PreviewOrderSubscriptionsAsync.md

@@ -8,6 +8,6 @@ Name | Type | Description | Notes
 **order_actions** | [**[PreviewOrderOrderAction]**](PreviewOrderOrderAction.md) | The actions to be applied to the subscription. Order actions will be stored with the sequence when it was provided in the request. | [optional] 
 **quote** | [**QuoteObjectFields**](QuoteObjectFields.md) |  | [optional] 
 **ramp** | [**CreateRamp**](CreateRamp.md) |  | [optional] 
-**subscription_number** | **String** | Leave this field empty to represent new subscription creation, or specify a subscription number to update an existing subscription.  | [optional] 
+**subscription_number** | **String** | Leave this field empty to represent new subscription creation, or specify a subscription number to update an existing subscription. | [optional] 
 
 

package/docs/PreviewPaymentSchedule.md

@@ -5,14 +5,14 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **amount** | **Number** | Indicates the updated amount of the pending payment schedule items.  | [optional] 
-**currency** | **String** | Indicates the updated currency of the pending payment schedule items.  | [optional] 
-**occurrences** | **Number** | Indicates the updated number of payment schedule items that are created by the payment schedule.  | [optional] 
-**payment_gateway_id** | **String** | Indicates the updated payment gateway ID of the pending payment schedule items.  | [optional] 
-**payment_method_id** | **String** | Indicates the updated payment method ID of the pending payment schedule items.  | [optional] 
-**payment_option** | [**[PaymentSchedulePaymentOptionFields]**](PaymentSchedulePaymentOptionFields.md) | Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.  Here is an example: ``` \"paymentOption\": [   {     \"type\": \"GatewayOptions\",     \"detail\": {       \"SecCode\":\"WEB\"     }   } ] ```  `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.  To enable this field, submit a request at [Zuora Global Support](https://support.zuora.com/). This field is only available if `zuora-version` is set to `337.0` or later.  | [optional] 
+**currency** | **String** | Indicates the updated currency of the pending payment schedule items. | [optional] 
+**occurrences** | **Number** | Indicates the updated number of payment schedule items that are created by the payment schedule. | [optional] 
+**payment_gateway_id** | **String** | Indicates the updated payment gateway ID of the pending payment schedule items. | [optional] 
+**payment_method_id** | **String** | Indicates the updated payment method ID of the pending payment schedule items. | [optional] 
+**payment_option** | [**[PaymentSchedulePaymentOptionFields]**](PaymentSchedulePaymentOptionFields.md) | Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.   Here is an example:  ```  \"paymentOption\": [   {     \"type\": \"GatewayOptions\",     \"detail\": {       \"SecCode\":\"WEB\"     }   } ]  ```   `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.   To enable this field, submit a request at [Zuora Global Support](https://support.zuora.com/). This field is only available if `zuora-version` is set to `337.0` or later. | [optional] 
 **period** | **String** | Indicates the updated period of the pending payment schedule items.  | [optional] 
-**period_start_date** | **String** | Indicates the updated collection date for the next pending payment schedule item.  | [optional] 
-**run_hour** | **Number** | Specifies at which hour of the day in the tenant’s time zone this payment will be collected. Available values: `[0,1,2,~,22,23]`.    If the time difference between your tenant’s timezone and the timezone where Zuora servers are is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half hour later than your scheduled time. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.  | [optional] 
+**period_start_date** | **String** | Indicates the updated collection date for the next pending payment schedule item. | [optional] 
+**run_hour** | **Number** | Specifies at which hour of the day in the tenant’s time zone this payment will be collected. Available values: `[0,1,2,~,22,23]`.    If the time difference between your tenant’s timezone and the timezone where Zuora servers are is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half hour later than your scheduled time. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs. | [optional] 
 
 
 

package/docs/PreviewResultOrderMetricsInnerOrderActionsInner.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**order_items** | [**[OrderItem]**](OrderItem.md) | The `orderItems` nested field is only available to existing Orders customers who already have access to the field.  **Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics. * The Order ELP and Order Item objects  * The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects  Existing Orders customers who have these metrics will continue to be supported.  | [optional] 
-**order_metrics** | [**[OrderMetric]**](OrderMetric.md) | The container for order metrics.  **Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics. * The Order ELP and Order Item objects  * The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects  Existing Orders customers who have these metrics will continue to be supported.  | [optional] 
+**order_items** | [**[OrderItem]**](OrderItem.md) | The `orderItems` nested field is only available to existing Orders customers who already have access to the field.   **Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.  * The Order ELP and Order Item objects   * The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects   Existing Orders customers who have these metrics will continue to be supported. | [optional] 
+**order_metrics** | [**[OrderMetric]**](OrderMetric.md) | The container for order metrics.   **Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.  * The Order ELP and Order Item objects   * The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects   Existing Orders customers who have these metrics will continue to be supported. | [optional] 
 **sequence** | **String** |  | [optional] 
 **type** | **String** |  | [optional] 
 

package/docs/PreviewSubscriptionAccountInfo.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **subsidiary__ns** | **String** | Value of the Subsidiary field for the corresponding customer account in NetSuite. The Subsidiary field is required if you use NetSuite OneWorld. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
 **sync_date__ns** | **String** | Date when the account was sychronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
 **syncto_net_suite__ns** | [**AccountObjectNSFieldsSynctoNetSuiteNS**](AccountObjectNSFieldsSynctoNetSuiteNS.md) |  | [optional] 
-**bill_cycle_day** | **Number** | The account's bill cycle day (BCD), when bill runs generate invoices for the account. Specify any day of the month (`1`-`31`, where `31` = end-of-month), or `0` for auto-set.  | 
+**bill_cycle_day** | **Number** | The account's bill cycle day (BCD), when bill runs generate invoices for the account. Specify any day of the month (`1`-`31`, where `31` = end-of-month), or `0` for auto-set. | 
 **bill_to_contact** | [**PreviewSubscriptionBillToContact**](PreviewSubscriptionBillToContact.md) |  | 
 **currency** | **String** | A currency as defined in Billing Settings.  | 
 

package/docs/PreviewSubscriptionBillToContact.md

@@ -4,11 +4,11 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**city** | **String** | The city of the bill-to address. The value should be 40 characters or less.  | [optional] 
-**country** | **String** | The country of the bill-to address. The value must be a valid country name or abbreviation.  **Note:** You must specify this field if you are using Zuora Tax for this account.  | [optional] 
-**county** | **String** | The county of the bill-to address. The value should be 32 characters or less.  | [optional] 
-**state** | **String** | The state of the bill-to address. The value must be a valid state or province name or 2-character abbreviation.  **Note:** You must specify this field if you are using Zuora Tax for this account and the country is `USA` or `Canada`.  | [optional] 
-**tax_region** | **String** | If using Zuora Tax, a region string as optionally defined in your tax rules.  | [optional] 
-**zip_code** | **String** | The zip code of the bill-to address. The value should be 20 characters or less.  | [optional] 
+**city** | **String** | The city of the bill-to address. The value should be 40 characters or less. | [optional] 
+**country** | **String** | The country of the bill-to address. The value must be a valid country name or abbreviation.   **Note:** You must specify this field if you are using Zuora Tax for this account. | [optional] 
+**county** | **String** | The county of the bill-to address. The value should be 32 characters or less. | [optional] 
+**state** | **String** | The state of the bill-to address. The value must be a valid state or province name or 2-character abbreviation.   **Note:** You must specify this field if you are using Zuora Tax for this account and the country is `USA` or `Canada`. | [optional] 
+**tax_region** | **String** | If using Zuora Tax, a region string as optionally defined in your tax rules. | [optional] 
+**zip_code** | **String** | The zip code of the bill-to address. The value should be 20 characters or less. | [optional] 
 
 

package/docs/PreviewSubscriptionInvoice.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **amount** | **Number** | Invoice amount. | [optional] 
 **amount_without_tax** | **Number** | Invoice amount minus tax.  | [optional] 
 **invoice_items** | [**[PreviewSubscriptionInvoiceItem]**](PreviewSubscriptionInvoiceItem.md) | Container for invoice items.  | [optional] 
-**target_date** | **String** | Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.  **Note:** This field is only available if you set the Zuora REST API minor version to 207.0 or later in the request header. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information.  | [optional] 
+**target_date** | **String** | Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.   **Note:** This field is only available if you set the Zuora REST API minor version to 207.0 or later in the request header. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information. | [optional] 
 **tax_amount** | **Number** | The tax amount of the invoice.  | [optional] 
 
 

package/docs/PreviewSubscriptionInvoiceItem.md

@@ -4,16 +4,16 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**charge_amount** | **Number** | The amount of the charge. This amount doesn't include taxes unless the charge's tax mode is inclusive.  | [optional] 
+**charge_amount** | **Number** | The amount of the charge. This amount doesn't include taxes unless the charge's tax mode is inclusive. | [optional] 
 **charge_description** | **String** | Description of the charge.  | [optional] 
 **charge_name** | **String** | Name of the charge.  | [optional] 
 **product_name** | **String** | Name of the product associated with this item.  | [optional] 
 **product_rate_plan_charge_id** | **String** | ID of the product rate plan charge.  | [optional] 
 **quantity** | **Number** | Quantity of this item.  | [optional] 
-**service_end_date** | **String** | End date of the service period for this item, i.e., the last day of the period, as yyyy-mm-dd.  | [optional] 
-**service_start_date** | **String** | Service start date as yyyy-mm-dd. If the charge is a one-time fee, this is the date of that charge.  | [optional] 
+**service_end_date** | **String** | End date of the service period for this item, i.e., the last day of the period, as yyyy-mm-dd. | [optional] 
+**service_start_date** | **String** | Service start date as yyyy-mm-dd. If the charge is a one-time fee, this is the date of that charge. | [optional] 
 **tax_amount** | **Number** | The tax amount of the invoice item.  | [optional] 
-**taxation_items** | [**[SubscriptionTaxationItem]**](SubscriptionTaxationItem.md) | List of taxation items. **Note**: This field is only available if you set the `zuora-version` request header to `315.0` or later.  | [optional] 
+**taxation_items** | [**[SubscriptionTaxationItem]**](SubscriptionTaxationItem.md) | List of taxation items.  **Note**: This field is only available if you set the `zuora-version` request header to `315.0` or later.  | [optional] 
 **unit_of_measure** | **String** |  | [optional] 
 
 

package/docs/PreviewSubscriptionRequest.md

@@ -4,23 +4,23 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**account_key** | **String** |  Customer account number or ID.  You must specify the account information either in this field or in the `previewAccountInfo` field with the following conditions:           * If you already have a customer account, specify the account number or ID in this field. * If you do not have a customer account, provide account information in the `previewAccountInfo` field.  | [optional] 
+**account_key** | **String** |  Customer account number or ID.   You must specify the account information either in this field or in the `previewAccountInfo` field with the following conditions:           * If you already have a customer account, specify the account number or ID in this field.  * If you do not have a customer account, provide account information in the `previewAccountInfo` field. | [optional] 
 **contract_effective_date** | **String** | Effective contract date for this subscription, as yyyy-mm-dd.  | 
-**customer_acceptance_date** | **String** | The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd.  Default value is dependent on the value of other fields. See **Notes** section for more details.  | [optional] 
-**document_date** | **String** | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.  - If this field is specified, the specified date is used as the billing document date.  - If this field is not specified, the date specified in the `targetDate` is used as the billing document date.  | [optional] 
-**include_existing_draft_doc_items** | **Boolean** | Specifies whether to include draft invoice items in subscription previews. Values are:  * `true` (default). Includes draft invoice items in the preview result. * `false`. Excludes draft invoice items in the preview result.  **Note:** This field is in Zuora REST API version control. Supported minor versions are 207.0 or later. To use this field in the method, you must set the **zuora-version** parameter to the minor version number in the request header. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information.  | [optional] 
-**include_existing_draft_invoice_items** | **Boolean** | Specifies whether to include draft invoice items in previews. Values are:  * `true` (default). Includes draft invoice items in the preview result. * `false`. Excludes draft invoice items in the preview result.  **Note:** This field is in Zuora REST API version control. Supported minor versions are 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information.  | [optional] 
-**initial_term** | **Number** | Duration of the first term of the subscription, in whole months. If `termType` is `TERMED`, then this field is required, and the value must be greater than `0`. If `termType` is `EVERGREEN`, this field is ignored.      | [optional] 
+**customer_acceptance_date** | **String** | The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd.   Default value is dependent on the value of other fields. See **Notes** section for more details. | [optional] 
+**document_date** | **String** | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.   - If this field is specified, the specified date is used as the billing document date.   - If this field is not specified, the date specified in the `targetDate` is used as the billing document date. | [optional] 
+**include_existing_draft_doc_items** | **Boolean** | Specifies whether to include draft invoice items in subscription previews.  Values are:   * `true` (default). Includes draft invoice items in the preview result.  * `false`. Excludes draft invoice items in the preview result.   **Note:** This field is in Zuora REST API version control. Supported minor versions are 207.0 or later. To use this field in the method, you must set the **zuora-version** parameter to the minor version number in the request header. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information. | [optional] 
+**include_existing_draft_invoice_items** | **Boolean** | Specifies whether to include draft invoice items in previews.  Values are:   * `true` (default). Includes draft invoice items in the preview result.  * `false`. Excludes draft invoice items in the preview result.   **Note:** This field is in Zuora REST API version control. Supported minor versions are 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information. | [optional] 
+**initial_term** | **Number** | Duration of the first term of the subscription, in whole months. If `termType` is `TERMED`, then this field is required, and the value must be greater than `0`. If `termType` is `EVERGREEN`, this field is ignored.     | [optional] 
 **initial_term_period_type** | **String** | The period type of the initial term.   Supported values are:  * `Month` * `Year` * `Day` * `Week`   The default period type is `Month`.   | [optional] 
-**invoice_owner_account_key** | **String** | Invoice owner account number or ID.  **Note:** This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).  | [optional] 
-**invoice_target_date** | **String** | Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.  **Note:** This field is in Zuora REST API version control. Supported minor versions are 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information.  | [optional] 
+**invoice_owner_account_key** | **String** | Invoice owner account number or ID.   **Note:** This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). | [optional] 
+**invoice_target_date** | **String** | Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.   **Note:** This field is in Zuora REST API version control. Supported minor versions are 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information. | [optional] 
 **notes** | **String** | String of up to 500 characters. | [optional] 
 **preview_account_info** | [**PreviewSubscriptionAccountInfo**](PreviewSubscriptionAccountInfo.md) |  | [optional] 
-**preview_type** | **String** | The type of preview you will receive.   This field is in Zuora REST API version control. The supported values of this field depend on the REST API minor version you specified in the request header.   * If you do not specify the REST API minor version or specify the minor version number to one of following values in the request header:     * 186.0   * 187.0   * 188.0   * 189.0   * 196.0   * 206.0      The following values are supported in the **previewType** field:    * InvoiceItem   * ChargeMetrics   * InvoiceItemChargeMetrics      The default value is InvoiceItem.  * If you specify the REST API minor version to 207.0 or later in the request header, the following values are supported in the **previewType** field:    - LegalDoc   - ChargeMetrics   - LegalDocChargeMetrics    The default value is LegalDoc.  See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information.  | [optional] 
-**service_activation_date** | **String** | The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd.  Default value is dependent on the value of other fields. See **Notes** section for more details.  | [optional] 
+**preview_type** | **String** | The type of preview you will receive.    This field is in Zuora REST API version control. The supported values of this field depend on the REST API minor version you specified in the request header.    * If you do not specify the REST API minor version or specify the minor version number to one of following values in the request header:     * 186.0   * 187.0   * 188.0   * 189.0   * 196.0   * 206.0      The following values are supported in the **previewType** field:    * InvoiceItem   * ChargeMetrics   * InvoiceItemChargeMetrics      The default value is InvoiceItem.  * If you specify the REST API minor version to 207.0 or later in the request header, the following values are supported in the **previewType** field:    - LegalDoc   - ChargeMetrics   - LegalDocChargeMetrics    The default value is LegalDoc.  See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information. | [optional] 
+**service_activation_date** | **String** | The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd.   Default value is dependent on the value of other fields. See **Notes** section for more details. | [optional] 
 **subscribe_to_rate_plans** | [**[CreateSubscriptionRatePlan]**](CreateSubscriptionRatePlan.md) | Container for one or more rate plans for this subscription.  | 
-**target_date** | **String** | Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.  **Note:** This field is in Zuora REST API version control. Supported minor versions are 207.0 or later. To use this field in the method, you must set the **zuora-version** parameter to the minor version number in the request header. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information.  | [optional] 
-**term_start_date** | **String** | The date on which the subscription term begins, as yyyy-mm-dd. If this is a renewal subscription, this date is different from the subscription start date.  | [optional] 
+**target_date** | **String** | Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.   **Note:** This field is in Zuora REST API version control. Supported minor versions are 207.0 or later. To use this field in the method, you must set the **zuora-version** parameter to the minor version number in the request header. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information. | [optional] 
+**term_start_date** | **String** | The date on which the subscription term begins, as yyyy-mm-dd. If this is a renewal subscription, this date is different from the subscription start date. | [optional] 
 **term_type** | **String** | Possible values are: `TERMED`, `EVERGREEN`.  | 
 
 

package/docs/PreviewSubscriptionResponse.md

@@ -9,12 +9,12 @@ Name | Type | Description | Notes
 **charge_metrics** | [**[ChargeMetrics]**](ChargeMetrics.md) |  | [optional] 
 **contracted_mrr** | **Number** | Monthly recurring revenue of the subscription.  | [optional] 
 **credit_memo** | [**SubscriptionCreditMemo**](SubscriptionCreditMemo.md) |  | [optional] 
-**document_date** | **String** | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.  - If this field is specified, the specified date is used as the billing document date.  - If this field is not specified, the date specified in the `targetDate` is used as the billing document date.  | [optional] 
+**document_date** | **String** | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.   - If this field is specified, the specified date is used as the billing document date.   - If this field is not specified, the date specified in the `targetDate` is used as the billing document date. | [optional] 
 **invoice** | [**PreviewSubscriptionInvoice**](PreviewSubscriptionInvoice.md) |  | [optional] 
 **invoice_items** | [**[PreviewSubscriptionInvoiceItem]**](PreviewSubscriptionInvoiceItem.md) | Container for invoice items. This field is in Zuora REST API version control. Supported minor versions are `206.0` and earlier. It is moved to this **invoice** container after 206.0  | [optional] 
-**invoice_target_date** | **String** | Date through which charges are calculated on the invoice, as yyyy-mm-dd.  **Note:** This field is only available if you do not specify the Zuora REST API minor version or specify the minor version to 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information.  | [optional] 
+**invoice_target_date** | **String** | Date through which charges are calculated on the invoice, as yyyy-mm-dd.   **Note:** This field is only available if you do not specify the Zuora REST API minor version or specify the minor version to 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information. | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
-**target_date** | **String** | Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.  **Note:** This field is only available if you set the Zuora REST API minor version to 207.0 or later in the request header. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information.  | [optional] 
+**target_date** | **String** | Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.   **Note:** This field is only available if you set the Zuora REST API minor version to 207.0 or later in the request header. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information. | [optional] 
 **tax_amount** | **Number** | Tax amount on the invoice. This field is in Zuora REST API version control. Supported minor versions are `206.0` and earlier. It is moved to this **invoice** container after 206.0  | [optional] 
 **total_contracted_value** | **Number** | Total contracted value of the subscription.  | [optional] 
 

package/docs/PricingUpdate.md

@@ -4,18 +4,18 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**charge_model_data** | [**ChargeModelDataOverride**](ChargeModelDataOverride.md) | Container for charge model configuration data.  **Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.  | [optional] 
+**charge_model_data** | [**ChargeModelDataOverride**](ChargeModelDataOverride.md) | Container for charge model configuration data.   **Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information. | [optional] 
 **discount** | [**DiscountPricingUpdate**](DiscountPricingUpdate.md) | Pricing information about a discount charge.  | [optional] 
-**recurring_delivery** | [**RecurringDeliveryPricingUpdate**](RecurringDeliveryPricingUpdate.md) | Pricing information about a recurring charge that uses the \"delivery\" charge model. This field is only available if you have the Delivery Pricing charge model enabled.  **Note**: The Delivery Pricing charge model is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at <a href=\"http://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>.  | [optional] 
-**recurring_flat_fee** | [**RecurringFlatFeePricingUpdate**](RecurringFlatFeePricingUpdate.md) | Pricing information about a recurring charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.  | [optional] 
-**recurring_per_unit** | [**RecurringPerUnitPricingUpdate**](RecurringPerUnitPricingUpdate.md) | Pricing information about a recurring charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased.  | [optional] 
-**recurring_tiered** | [**RecurringTieredPricingUpdate**](RecurringTieredPricingUpdate.md) | Pricing information about a recurring charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.  | [optional] 
-**recurring_volume** | [**RecurringVolumePricingUpdate**](RecurringVolumePricingUpdate.md) | Pricing information about a recurring charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.  | [optional] 
-**usage_flat_fee** | [**UsageFlatFeePricingUpdate**](UsageFlatFeePricingUpdate.md) | Pricing information about a usage charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.  | [optional] 
-**usage_overage** | [**UsageOveragePricingUpdate**](UsageOveragePricingUpdate.md) | Pricing information about a usage charge that uses the \"overage\" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed.  | [optional] 
-**usage_per_unit** | [**UsagePerUnitPricingUpdate**](UsagePerUnitPricingUpdate.md) | Pricing information about a usage charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit consumed.  | [optional] 
-**usage_tiered** | [**UsageTieredPricingUpdate**](UsageTieredPricingUpdate.md) | Pricing information about a usage charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed.  | [optional] 
-**usage_tiered_with_overage** | [**UsageTieredWithOveragePricingUpdate**](UsageTieredWithOveragePricingUpdate.md) | Pricing information about a usage charge that uses the \"tiered with overage\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier.  | [optional] 
-**usage_volume** | [**UsageVolumePricingUpdate**](UsageVolumePricingUpdate.md) | Pricing information about a usage charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed.  | [optional] 
+**recurring_delivery** | [**RecurringDeliveryPricingUpdate**](RecurringDeliveryPricingUpdate.md) | Pricing information about a recurring charge that uses the \"delivery\" charge model. This field is only available if you have the Delivery Pricing charge model enabled.   **Note**: The Delivery Pricing charge model is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at <a href=\"http://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>. | [optional] 
+**recurring_flat_fee** | [**RecurringFlatFeePricingUpdate**](RecurringFlatFeePricingUpdate.md) | Pricing information about a recurring charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price. | [optional] 
+**recurring_per_unit** | [**RecurringPerUnitPricingUpdate**](RecurringPerUnitPricingUpdate.md) | Pricing information about a recurring charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased. | [optional] 
+**recurring_tiered** | [**RecurringTieredPricingUpdate**](RecurringTieredPricingUpdate.md) | Pricing information about a recurring charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased. | [optional] 
+**recurring_volume** | [**RecurringVolumePricingUpdate**](RecurringVolumePricingUpdate.md) | Pricing information about a recurring charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased. | [optional] 
+**usage_flat_fee** | [**UsageFlatFeePricingUpdate**](UsageFlatFeePricingUpdate.md) | Pricing information about a usage charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price. | [optional] 
+**usage_overage** | [**UsageOveragePricingUpdate**](UsageOveragePricingUpdate.md) | Pricing information about a usage charge that uses the \"overage\" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed. | [optional] 
+**usage_per_unit** | [**UsagePerUnitPricingUpdate**](UsagePerUnitPricingUpdate.md) | Pricing information about a usage charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit consumed. | [optional] 
+**usage_tiered** | [**UsageTieredPricingUpdate**](UsageTieredPricingUpdate.md) | Pricing information about a usage charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. | [optional] 
+**usage_tiered_with_overage** | [**UsageTieredWithOveragePricingUpdate**](UsageTieredWithOveragePricingUpdate.md) | Pricing information about a usage charge that uses the \"tiered with overage\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier. | [optional] 
+**usage_volume** | [**UsageVolumePricingUpdate**](UsageVolumePricingUpdate.md) | Pricing information about a usage charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed. | [optional] 
 
 

package/docs/ProcessingOptions.md

@@ -4,17 +4,17 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**application_order** | **[String]** | The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.  **Note:**   - This field is valid only if the `applyCredit` field is set to `true`.   - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.   - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices.  | [optional] 
-**apply_credit** | **Boolean** | Whether to automatically apply credit memos or unapplied payments, or both to an invoice.  If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.             **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.  | [optional] 
-**apply_credit_balance** | **Boolean** | Indicates if any credit balance on a customer's account is automatically applied to invoices. If no value is specified then this field defaults to false. This feature is not available if you have enabled the Invoice Settlement feature.  | [optional] 
+**application_order** | **[String]** | The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.   **Note:**   - This field is valid only if the `applyCredit` field is set to `true`.   - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.   - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices. | [optional] 
+**apply_credit** | **Boolean** | Whether to automatically apply credit memos or unapplied payments, or both to an invoice.   If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.              **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. | [optional] 
+**apply_credit_balance** | **Boolean** | Indicates if any credit balance on a customer's account is automatically applied to invoices. If no value is specified then this field defaults to false. This feature is not available if you have enabled the Invoice Settlement feature. | [optional] 
 **billing_options** | [**BillingOptions**](BillingOptions.md) |  | [optional] 
-**collect_payment** | **Boolean** | Indicates if the current request needs to collect payments. This value can not be 'true' when 'runBilling' flag is 'false'.  | [optional] 
+**collect_payment** | **Boolean** | Indicates if the current request needs to collect payments. This value can not be 'true' when 'runBilling' flag is 'false'. | [optional] 
 **electronic_payment_options** | [**ElectronicPaymentOptions**](ElectronicPaymentOptions.md) |  | [optional] 
-**refund** | **Boolean** | Indicates whether to refund after subscription cancelation. Default is `false`.   **Note**: When refunding a subscription that is not invoiced separately, if you do not enable the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Invoice_Settlement/C_Invoice_Item_Settlement\" target=\"_blank\">Invoice Item Settlement</a> feature, you will encounter the following error during the cancel and refund process: “Cancellation/Refund failed because of the following reason: Invoice is linked to multiple subscriptions. Cancellation was not processed.”  | [optional] 
-**refund_amount** | **Number** | Indicates the amount to be refunded. Required if the `refund` field is `true`.  | [optional] 
-**refund_reason_code** | **String** | A code identifying the reason for the refund transaction. The value must be an existing payment refund reason code listed in **Payments Settings** > **Configure Reason Codes**. If you do not specify the field or leave the field with an empty value, Zuora uses the default payment refund reason code.  | [optional] 
-**run_billing** | **Boolean** | Indicates if the current request needs to generate an invoice. The invoice will be generated against all subscriptions included in this order.  | [optional] 
-**write_off** | **Boolean** | Indicates whether to write off the outstanding balance on the invoice after refund. Default is `false`.  **Note**:  - When refunding a subscription that is not invoiced separately, if you do not enable the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Invoice_Settlement/C_Invoice_Item_Settlement\" target=\"_blank\">Invoice Item Settlement</a> feature, you will encounter the following error during the cancel and refund process: “Cancellation/Refund failed because of the following reason: Invoice is linked to multiple subscriptions. Cancellation was not processed.” - The <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Invoice_Settlement\" target=\"_blank\">Invoice Settlement</a> feature must have been enabled for write-off.  | [optional] 
+**refund** | **Boolean** | Indicates whether to refund after subscription cancelation. Default is `false`.    **Note**: When refunding a subscription that is not invoiced separately, if you do not enable the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Invoice_Settlement/C_Invoice_Item_Settlement\" target=\"_blank\">Invoice Item Settlement</a> feature, you will encounter the following error during the cancel and refund process: “Cancellation/Refund failed because of the following reason: Invoice is linked to multiple subscriptions. Cancellation was not processed.” | [optional] 
+**refund_amount** | **Number** | Indicates the amount to be refunded. Required if the `refund` field is `true`. | [optional] 
+**refund_reason_code** | **String** | A code identifying the reason for the refund transaction. The value must be an existing payment refund reason code listed in **Payments Settings** > **Configure Reason Codes**. If you do not specify the field or leave the field with an empty value, Zuora uses the default payment refund reason code. | [optional] 
+**run_billing** | **Boolean** | Indicates if the current request needs to generate an invoice. The invoice will be generated against all subscriptions included in this order. | [optional] 
+**write_off** | **Boolean** | Indicates whether to write off the outstanding balance on the invoice after refund. Default is `false`.   **Note**:   - When refunding a subscription that is not invoiced separately, if you do not enable the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Invoice_Settlement/C_Invoice_Item_Settlement\" target=\"_blank\">Invoice Item Settlement</a> feature, you will encounter the following error during the cancel and refund process: “Cancellation/Refund failed because of the following reason: Invoice is linked to multiple subscriptions. Cancellation was not processed.”  - The <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Invoice_Settlement\" target=\"_blank\">Invoice Settlement</a> feature must have been enabled for write-off. | [optional] 
 **write_off_behavior** | [**WriteOffBehavior**](WriteOffBehavior.md) |  | [optional]