zuora-sdk-js 3.6.0 → 3.7.0

package/docs/CreateMassUpdaterRequest.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**file** | **File** | File containing data about the mass action you want to perform. The file requirements are the same as when uploading a file through the Mass Updater in the Zuora UI. The file must be a `.csv` file or a zipped `.csv` file.  The maximum file size is 4 MB.  The data in the file must be formatted according to the mass action type you want to perform.  | 
-**params** | **String** | Container for the following fields. You must format this parameter as a JSON object.  * `actionType` (string, **Required**) - Type of mass action you want to perform. The following mass actions are supported: `UpdateAccountingCode`, `CreateRevenueSchedule`, `UpdateRevenueSchedule`, `DeleteRevenueSchedule`, `ImportFXRate`, and `MPU`.  * `checksum` (string) - An MD5 checksum that is used to validate the integrity of   the uploaded file. The checksum is a 32-character string.  | 
+**file** | **File** | File containing data about the mass action you want to perform. The file requirements are the same as when uploading a file through the Mass Updater in the Zuora UI. The file must be a `.csv` file or a zipped `.csv` file.   The maximum file size is 4 MB.   The data in the file must be formatted according to the mass action type you want to perform. | 
+**params** | **String** | Container for the following fields. You must format this parameter as a JSON object.   * `actionType` (string, **Required**) - Type of mass action you want to perform. The following mass actions are supported: `UpdateAccountingCode`, `CreateRevenueSchedule`, `UpdateRevenueSchedule`, `DeleteRevenueSchedule`, `ImportFXRate`, and `MPU`.   * `checksum` (string) - An MD5 checksum that is used to validate the integrity of   the uploaded file. The checksum is a 32-character string. | 
 
 

package/docs/CreateOmniChannelSubscriptionResponse.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]
 **subscription_id** | **String** | The system generated Id in Billing, the subscriptionId.  | [optional] 
 **subscription_number** | **String** | The system generated subscription number.  | [optional] 
 **account_id** | **String** | The ID of the account associated with this subscription.  | [optional] 

package/docs/CreateOpenPaymentMethodTypeRequest.md

@@ -4,13 +4,13 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**entity_id** | **String** | If this custom payment method type is specific to one entity only, provide the entity ID in this field in UUID format, such as `123e4567-e89b-12d3-a456-426614174000`. If no entity UUID is provided, the custom payment method type is available to the global entity and all the sub entities in the tenant.  You can get the entity ID through the [Multi-entity: List entities](https://www.zuora.com/developer/api-references/older-api/operation/Get_Entities/) API operation or the **Manage Entity Profile** administration setting in the UI. To convert the format of the entity ID to UUID, separate the entity ID string in five groups with hyphens, in the form `<8-characters>-<4-characters>-<4-characters>-<4-characters>-<12-characters>` for a total of 36 characters.  Note: After the custom payment method type is created, you can only update this field to be empty.  | [optional] 
+**entity_id** | **String** | If this custom payment method type is specific to one entity only, provide the entity ID in this field in UUID format, such as `123e4567-e89b-12d3-a456-426614174000`. If no entity UUID is provided, the custom payment method type is available to the global entity and all the sub entities in the tenant.   You can get the entity ID through the [Multi-entity: List entities](https://www.zuora.com/developer/api-references/older-api/operation/Get_Entities/) API operation or the **Manage Entity Profile** administration setting in the UI. To convert the format of the entity ID to UUID, separate the entity ID string in five groups with hyphens, in the form `<8-characters>-<4-characters>-<4-characters>-<4-characters>-<12-characters>` for a total of 36 characters.   Note: After the custom payment method type is created, you can only update this field to be empty. | [optional] 
 **fields** | [**[OpenPaymentMethodTypeRequestFields]**](OpenPaymentMethodTypeRequestFields.md) | An array containing field metadata of the custom payment method type.  Notes:   - All the following nested metadata must be provided in the request to define a field.    - At least one field must be defined in the fields array for a custom payment method type.    - Up to 20 fields can be defined in the fields array for a custom payment method type.  | 
-**internal_name** | **String** | A string to identify the custom payment method type in the API name of the payment method type.  This field must be alphanumeric, starting with a capital letter, excluding JSON preserved characters such as  * \\ ’ ”. Additionally, '_' or '-' is not allowed.  This field must be unique in a tenant.  This field is used along with the `tenantId` field by the system to construct and generate the API name of the custom payment method type in the following way:  `<internalName>__c_<tenantId>`  For example, if `internalName` is `AmazonPay`, and `tenantId` is `12368`, the API name of the custom payment method type will be `AmazonPay__c_12368`.  This field cannot be updated after the creation of the custom payment method type.  | 
-**label** | **String** | The label that is used to refer to this type in the Zuora UI.  This value must be alphanumeric, excluding JSON preserved characters such as  * \\ ’ ”   | 
-**method_reference_id_field** | **String** | The identification reference of the custom payment method.  This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Payment Method Data Source Exports and Data Query.  This field cannot be updated after the creation of the custom payment method type.  | 
-**sub_type_field** | **String** | The identification reference indicating the subtype of the custom payment method.  This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.  This field cannot be updated after the creation of the custom payment method type.  | [optional] 
-**tenant_id** | **String** | Zuora tenant ID. If multi-entity is enabled in your tenant, this is the ID of the parent tenant of all the sub entities.  This field cannot be updated after the creation of the custom payment method type.  | 
-**user_reference_id_field** | **String** | The identification reference of the user or customer account.  This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.  This field cannot be updated after the creation of the custom payment method type.  | [optional] 
+**internal_name** | **String** | A string to identify the custom payment method type in the API name of the payment method type.   This field must be alphanumeric, starting with a capital letter, excluding JSON preserved characters such as  * \\ ’ ”. Additionally, '_' or '-' is not allowed.   This field must be unique in a tenant.   This field is used along with the `tenantId` field by the system to construct and generate the API name of the custom payment method type in the following way:   `<internalName>__c_<tenantId>`   For example, if `internalName` is `AmazonPay`, and `tenantId` is `12368`, the API name of the custom payment method type will be `AmazonPay__c_12368`.   This field cannot be updated after the creation of the custom payment method type. | 
+**label** | **String** | The label that is used to refer to this type in the Zuora UI.   This value must be alphanumeric, excluding JSON preserved characters such as  * \\ ’ ”  | 
+**method_reference_id_field** | **String** | The identification reference of the custom payment method.   This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Payment Method Data Source Exports and Data Query.   This field cannot be updated after the creation of the custom payment method type. | 
+**sub_type_field** | **String** | The identification reference indicating the subtype of the custom payment method.   This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.   This field cannot be updated after the creation of the custom payment method type. | [optional] 
+**tenant_id** | **String** | Zuora tenant ID. If multi-entity is enabled in your tenant, this is the ID of the parent tenant of all the sub entities.   This field cannot be updated after the creation of the custom payment method type. | 
+**user_reference_id_field** | **String** | The identification reference of the user or customer account.   This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.   This field cannot be updated after the creation of the custom payment method type. | [optional] 
 
 

package/docs/CreateOrUpdateCatalogGroupProductRatePlan.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**grade** | **Number** | The grade that is assigned for the product rate plan. The value of this field must be a positive integer. The greater the value, the higher the grade.  A product rate plan to be added to a Grading catalog group must have one grade. You can specify a grade for a product rate plan in this request or update the product rate plan individually.  | [optional] 
+**grade** | **Number** | The grade that is assigned for the product rate plan. The value of this field must be a positive integer. The greater the value, the higher the grade.   A product rate plan to be added to a Grading catalog group must have one grade. You can specify a grade for a product rate plan in this request or update the product rate plan individually. | [optional] 
 **id** | **String** | The unique ID of the product rate plan.  | [optional] 
 
 

package/docs/CreateOrderAddProduct.md

@@ -6,13 +6,13 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **charge_overrides** | [**[ChargeOverride]**](ChargeOverride.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] 
-**external_catalog_plan_id** | **String** | An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan.  **Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.  | [optional] 
-**externally_managed_plan_id** | **String** | Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.  | [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] 
+**external_catalog_plan_id** | **String** | An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan.   **Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. | [optional] 
+**externally_managed_plan_id** | **String** | Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores. | [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] 
 **is_from_external_catalog** | **Boolean** | Indicates whether the rate plan is created from the Zuora product catalog or from an external product catalog.  **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.  | [optional] 
 **rate_plan_name** | **String** | Name of the standalone rate plan.  **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.  | [optional] 

package/docs/CreateOrderChangePlanRatePlanOverride.md

@@ -6,13 +6,13 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **charge_overrides** | [**[ChargeOverride]**](ChargeOverride.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] 
-**external_catalog_plan_id** | **String** | An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan.  **Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.  | [optional] 
-**externally_managed_plan_id** | **String** | Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.  | [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] 
+**external_catalog_plan_id** | **String** | An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan.   **Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. | [optional] 
+**externally_managed_plan_id** | **String** | Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores. | [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] 
 **is_from_external_catalog** | **Boolean** | Indicates whether the rate plan is created from the Zuora product catalog or from an external product catalog.  **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.  | [optional] 
 **rate_plan_name** | **String** | Name of the standalone rate plan.  **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.  | [optional] 

package/docs/CreateOrderChargeUpdate.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] 
 **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] 
 **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] 
 **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** | [**CreateOrderPricingUpdate**](CreateOrderPricingUpdate.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/CreateOrderCreateSubscription.md

@@ -4,22 +4,22 @@
 
 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] 
+**bill_to_contact_id** | **String** | The ID of the bill-to contact associated with the subscription.  n**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_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] 
+**invoice_template_id** | **String** | The ID of the invoice template associated with the subscription.  n**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** | [**CreateOrderSubscriptionOwnerAccount**](CreateOrderSubscriptionOwnerAccount.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.  n**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] 
+**sold_to_contact_id** | **String** | The ID of the sold-to contact associated with the subscription.  n**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. it is belong to the subscription owner account | [optional] 
-**subscribe_to_products** | [**[CreateSubscribeToProduct]**](CreateSubscribeToProduct.md) | For a rate plan, the following fields are available:   - `chargeOverrides`   - `clearingExistingFeatures`   - `customFields`   - `externallyManagedPlanId`   - `newRatePlanId`   - `productRatePlanId`   - `subscriptionProductFeatures`   - `uniqueToken`     | [optional] 
+**subscribe_to_products** | [**[CreateSubscribeToProduct]**](CreateSubscribeToProduct.md) | For a rate plan, the following fields are available:   - `chargeOverrides`  - `clearingExistingFeatures`   - `customFields`   - `externallyManagedPlanId`  - `newRatePlanId`   - `productRatePlanId`   - `subscriptionProductFeatures`  - `uniqueToken`     | [optional] 
 **subscribe_to_rate_plans** | [**[CreateOrderRatePlanOverride]**](CreateOrderRatePlanOverride.md) | List of rate plans associated with the subscription.  **Note**: The `subscribeToRatePlans` field has been deprecated, this field is replaced by the `subscribeToProducts` field that supports Rate Plans. In a new order request, you can use either `subscribeToRatePlans` or `subscribeToProducts`, not both.  | [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] 
 **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** | [**OrderActionCreateSubscriptionTerms**](OrderActionCreateSubscriptionTerms.md) |  | [optional] 
-**currency** | **String** | The code of currency that is used for this subscription. If the currency is not selected, the default currency from the account will be used. All subscriptions in the same order must use the same currency. The currency for a subscription cannot be changed.  **Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currencies</a> feature enabled.   | [optional] 
+**currency** | **String** | The code of currency that is used for this subscription. If the currency is not selected, the default currency from the account will be used. All subscriptions in the same order must use the same currency. The currency for a subscription cannot be changed.  **Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currencies</a> feature enabled.  | [optional] 
 **invoice_group_number** | **String** | The number of invoice group 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] 
 **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] 
 **unique_token** | **String** | uniqueToken of the subscription to set relatedSubscriptionNumber in OLI within same order. Unique token should be a unique value for more than one create sub order action within same order.  | [optional] 

package/docs/CreateOrderPricingUpdate.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_based** | [**RecurringDeliveryPricingUpdate**](RecurringDeliveryPricingUpdate.md) | 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_based** | [**RecurringDeliveryPricingUpdate**](RecurringDeliveryPricingUpdate.md) | 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/CreateOrderProductRatePlanOverride.md

@@ -6,12 +6,12 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **charge_overrides** | [**[ChargeOverride]**](ChargeOverride.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] 
-**external_catalog_plan_id** | **String** | An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan.  **Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.  | [optional] 
-**externally_managed_plan_id** | **String** | Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.  | [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] 
+**external_catalog_plan_id** | **String** | An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan.   **Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. | [optional] 
+**externally_managed_plan_id** | **String** | Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores. | [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] 
 
 

package/docs/CreateOrderRatePlanOverride.md

@@ -6,13 +6,13 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **charge_overrides** | [**[ChargeOverride]**](ChargeOverride.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] 
-**external_catalog_plan_id** | **String** | An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan.  **Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.  | [optional] 
-**externally_managed_plan_id** | **String** | Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.  | [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] 
+**external_catalog_plan_id** | **String** | An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan.   **Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. | [optional] 
+**externally_managed_plan_id** | **String** | Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores. | [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] 
 **is_from_external_catalog** | **Boolean** | Indicates whether the rate plan is created from the Zuora product catalog or from an external product catalog.  **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.  | [optional] 
 **rate_plan_name** | **String** | Name of the standalone rate plan.  **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.  | [optional] 

package/docs/CreateOrderRatePlanUpdate.md

@@ -4,16 +4,16 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**charge_updates** | [**[CreateOrderChargeUpdate]**](CreateOrderChargeUpdate.md) | Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action.  | [optional] 
+**charge_updates** | [**[CreateOrderChargeUpdate]**](CreateOrderChargeUpdate.md) | Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action. | [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] 
-**external_catalog_plan_id** | **String** | An external ID of the rate plan to be updated. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to update the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.  **Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.  | [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] 
+**external_catalog_plan_id** | **String** | An external ID of the rate plan to be updated. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to update the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.   **Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. | [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] 
-**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] 
+**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_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] 
 **is_adding_subset_charges** | **Boolean** | Specifies whether to add subset charges to the subscription.  **Note:** This field is available when the EnableAddingSubsetCharges permission is enabled.  | [optional] 
 
 

package/docs/CreateOrderResponse.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]
 **account_id** | **String** | The account ID for the order. This field is returned instead of the `accountNumber` field if the `returnIds` query parameter is set to `true`. | [optional] 
 **account_number** | **String** | The account number for the order. | [optional] 
 **credit_memo_ids** | **[String]** | An array of the credit memo IDs generated in this order request. The credit memo is only available if you have the Invoice Settlement feature enabled. This field is returned instead of the `creditMemoNumbers` field if the `returnIds` query parameter is set to `true`. | [optional] 

package/docs/CreateOrderSubscription.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **order_actions** | [**[CreateOrderAction]**](CreateOrderAction.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 empty to represent new subscription creation. Specify a subscription number to update an existing subscription.  | [optional] 
+**notes** | **String** | A string of up to 65,535 characters.  | [optional] 
+**subscription_number** | **String** | Leave this empty to represent new subscription creation. Specify a subscription number to update an existing subscription. | [optional] 
 
 

package/docs/CreateOrderSubscriptionOwnerAccount.md

@@ -5,25 +5,25 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **account_number** | **String** | Account number. For example, A00000001.  | [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** | [**CreateAccountContact**](CreateAccountContact.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] 
 **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] 
-**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 the Credit Card Reference Transaction payment method, you can specify the payment method ID in this field or use the `paymentMethod` field to create a CC Reference Transaction payment method for an account.  | [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] 
+**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 the Credit Card Reference Transaction payment method, you can specify the payment method ID in this field or use the `paymentMethod` field to create a CC Reference Transaction payment method for an account. | [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] 
+**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] 
 **sold_to_contact** | [**CreateAccountContact**](CreateAccountContact.md) |  | [optional] 
 **tax_info** | [**TaxInfo**](TaxInfo.md) |  | [optional] 
 

package/docs/CreateOrderTermsAndConditions.md

@@ -5,17 +5,17 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **auto_renew** | **Boolean** |  | [optional] 
-**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] 
+**bill_to_contact_id** | **String** | The ID of the bill-to contact associated with the subscription.  n**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] 
 **clearing_existing_bill_to_contact** | **Boolean** | Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the `billToContactId` field.  **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.  | [optional] [default to false]
 **clearing_existing_invoice_template** | **Boolean** | Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the `invoiceTemplateId` field.  **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.  | [optional] [default to false]
 **clearing_existing_payment_term** | **Boolean** | Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the `paymentTerm` field.  **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.  | [optional] [default to false]
 **clearing_existing_sequence_set** | **Boolean** | Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the `sequenceSetId` field.  **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.  | [optional] [default to false]
 **clearing_existing_sold_to_contact** | **Boolean** | Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the `soldToContactId` field.  **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.  | [optional] [default to false]
 **invoice_separately** | **Boolean** | Specifies whether the subscription appears on a separate invoice when 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] 
+**invoice_template_id** | **String** | The ID of the invoice template associated with the subscription.  n**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] 
 **last_term** | [**LastTerm**](LastTerm.md) |  | [optional] 
 **term_increase_to_new_contract_line** | **Boolean** | Reflect the term increase to a new contract line when term increased or converts from Term to Evergreen | [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.  n**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] 
 **renewal_setting** | [**RenewalSetting**](RenewalSetting.md) |  | [optional] 
 **renewal_terms** | [**[RenewalTerm]**](RenewalTerm.md) |  | [optional] 
 **scheduled_cancel_date** | **String** | The date when the subscription is scheduled to be canceled. The subscription is not canceled until the date specified in this field.  | [optional] 
@@ -25,12 +25,12 @@ Name | Type | Description | Notes
 **clearing_scheduled_suspend_date** | **Boolean** | Whether to clear the scheduled suspend date at the subscription level. This field is mutually exclusive with the scheduledSuspendDate field.  | [optional] 
 **clearing_scheduled_resume_date** | **Boolean** | Whether to clear the scheduled resume date at the subscription level. This field is mutually exclusive with the scheduledResumeDate field.  | [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] 
+**sold_to_contact_id** | **String** | The ID of the sold-to contact associated with the subscription.  n**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] 
-**clearing_existing_ship_to_contact** | **Boolean** | Whether to clear the existing ship-to contact ID at the subscription level. This field is mutually exclusive with the `shipToContactId` field.  | [optional] 
+**clearing_existing_ship_to_contact** | **Boolean** | Whether to clear the existing ship-to contact ID at the subscription level. This field is mutually exclusive with the `shipToContactId` field. | [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] 
-**clearing_existing_communication_profile** | **Boolean** | Whether to clear the existing communication profile at the subscription level. This field is mutually exclusive with the `communicationProfileId` field.  | [optional] 
+**clearing_existing_communication_profile** | **Boolean** | Whether to clear the existing communication profile at the subscription level. This field is mutually exclusive with the `communicationProfileId` field. | [optional] 
 **invoice_group_number** | **String** | The number of invoice group 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] 
-**clearing_existing_invoice_group_number** | **Boolean** | Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the `invoiceGroupNumber` field. **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] [default to false]
+**clearing_existing_invoice_group_number** | **Boolean** | Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the `invoiceGroupNumber` field.  **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] [default to false]
 
 

package/docs/CreateOrderUpdateProduct.md

@@ -4,16 +4,16 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**charge_updates** | [**[CreateOrderChargeUpdate]**](CreateOrderChargeUpdate.md) | Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action.  | [optional] 
+**charge_updates** | [**[CreateOrderChargeUpdate]**](CreateOrderChargeUpdate.md) | Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action. | [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] 
-**external_catalog_plan_id** | **String** | An external ID of the rate plan to be updated. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to update the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.  **Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.  | [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] 
+**external_catalog_plan_id** | **String** | An external ID of the rate plan to be updated. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to update the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.   **Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. | [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] 
-**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] 
+**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_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] 
 **is_adding_subset_charges** | **Boolean** | Specifies whether to add subset charges to the subscription.  **Note:** This field is available when the EnableAddingSubsetCharges permission is enabled.  | [optional] 
 
 

package/docs/CreatePaymentDebitMemoApplication.md

@@ -7,6 +7,6 @@ Name | Type | Description | Notes
 **amount** | **Number** | The amount of the payment associated with the debit memo.  | 
 **debit_memo_id** | **String** | The unique ID of the debit memo that the payment is created on.  | [optional] 
 **debit_memo_number** | **String** |  | [optional] 
-**items** | [**[CreatePaymentDebitMemoApplicationItem]**](CreatePaymentDebitMemoApplicationItem.md) | Container for debit memo items. The maximum number of items is 1,000.  **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish 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] 
+**items** | [**[CreatePaymentDebitMemoApplicationItem]**](CreatePaymentDebitMemoApplicationItem.md) | Container for debit memo items. The maximum number of items is 1,000.   **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish 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] 
 
 

package/docs/CreatePaymentDebitMemoApplicationItem.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**amount** | **Number** | The amount of the payment associated with the specific debit memo or taxation item.  | 
+**amount** | **Number** | The amount of the payment associated with the specific debit memo or taxation item. | 
 **debit_memo_item_id** | **String** | The ID of the specific debit memo item.  | [optional] 
 **tax_item_id** | **String** | The ID of the specific taxation item.  | [optional] 
 

package/docs/CreatePaymentInvoiceApplication.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**amount** | **Number** | The amount of the payment associated with the invoice. This amount must be equal to or lesser than the balance of the invoice.  | 
-**invoice_id** | **String** | The unique ID of the invoice that the payment is created on. The balance of the invoice specified must not be `0`.  | [optional] 
+**amount** | **Number** | The amount of the payment associated with the invoice. This amount must be equal to or lesser than the balance of the invoice. | 
+**invoice_id** | **String** | The unique ID of the invoice that the payment is created on. The balance of the invoice specified must not be `0`. | [optional] 
 **invoice_number** | **String** |  | [optional] 
-**items** | [**[CreatePaymentInvoiceApplicationItem]**](CreatePaymentInvoiceApplicationItem.md) | Container for invoice items. The maximum number of items is 1,000.  **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish 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] 
+**items** | [**[CreatePaymentInvoiceApplicationItem]**](CreatePaymentInvoiceApplicationItem.md) | Container for invoice items. The maximum number of items is 1,000.   **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish 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]