zuora-sdk-js 3.6.0 → 3.7.0

package/docs/CreatePaymentScheduleRequest.md

@@ -4,24 +4,24 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**account_id** | **String** | ID of the customer account the payment schedule belongs to.  **Note:** `accountId` and `accountNumber` cannot both be `null`. When both fields are specified, the two values must match each other.  | [optional] 
-**account_number** | **String** | Account number of the customer account the payment schedule belongs to.  **Note:** `accountId` and `accountNumber` cannot both be `null`. When both fields are specified, the two values must match each other.  | [optional] 
-**amount** | **Number** | The amount of each payment schedule item in the payment schedule.  **Note:** - This field is required when `items` is not specified. - This field will be ignored when `items` is specified. - When creating recurring payment schedules, there are 2 options to specify amounts:     - Specify `totalAmount` and `occurrences`, `amount` will be calculated.   - Specify `amount` and `occurrences`, `totalAmount` will be calculated.   You must specify either `totalAmount` or `amount`. Specifying both fields at the same time is not allowed.  | [optional] 
+**account_id** | **String** | ID of the customer account the payment schedule belongs to.   **Note:**  `accountId` and `accountNumber` cannot both be `null`. When both fields are specified, the two values must match each other. | [optional] 
+**account_number** | **String** | Account number of the customer account the payment schedule belongs to.   **Note:**  `accountId` and `accountNumber` cannot both be `null`. When both fields are specified, the two values must match each other. | [optional] 
+**amount** | **Number** | The amount of each payment schedule item in the payment schedule.   **Note:**  - This field is required when `items` is not specified.  - This field will be ignored when `items` is specified.  - When creating recurring payment schedules, there are 2 options to specify amounts:     - Specify `totalAmount` and `occurrences`, `amount` will be calculated.   - Specify `amount` and `occurrences`, `totalAmount` will be calculated.   You must specify either `totalAmount` or `amount`. Specifying both fields at the same time is not allowed. | [optional] 
 **billing_document** | [**PaymentScheduleBillingDocument**](PaymentScheduleBillingDocument.md) |  | [optional] 
-**currency** | **String** | Currency of the payment schedule.  **Note:** - This field is optional. The default value is the account's default currency. - This field will be ignored when `items` is specified.  | [optional] 
+**currency** | **String** | Currency of the payment schedule.   **Note:**  - This field is optional. The default value is the account's default currency.  - This field will be ignored when `items` is specified. | [optional] 
 **description** | **String** | Description of the payment schedule. Max length is 255.  | [optional] 
 **items** | [**[CreatePaymentScheduleRequestItems]**](CreatePaymentScheduleRequestItems.md) | Container array for payment schedule items.  | [optional] 
-**occurrences** | **Number** | The number of payment schedule item to be created. Maximum value is 1000.  **Note:** - This field is required when `items` is not specified. - This field will be ignored when `items` is specified.  | [optional] 
-**payment_gateway_id** | **String** | ID of the payment gateway.  **Note:** - This field is optional. The default value is the account's default payment gateway ID. If no payment gateway ID is found on the cusotmer account level, the default value will be the tenant's default payment gateway ID. - This field will be ignored when `items` is specified.  | [optional] 
-**payment_method_id** | **String** | ID of the payment method.  **Note:** - This field is optional. The default value is the account's default payment method ID. - This field will be ignored when `items` is specified.  | [optional] 
-**payment_option** | [**[PaymentSchedulePaymentOptionFields]**](PaymentSchedulePaymentOptionFields.md) | Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.   Here is an example: ``` \"paymentOption\": [   {     \"type\": \"GatewayOptions\",     \"detail\": {       \"SecCode\":\"WEB\"     }   } ] ```  `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.  To enable this field, submit a request at [Zuora Global Support](https://support.zuora.com/). This field is only available if `zuora-version` is set to `337.0` or later.  | [optional] 
-**payment_schedule_number** | **String** | You can use this field to specify the number of the payment schedule. Only characters from the following sets are allowed: A-Z, a-z, 0-9, and `-`.  Payment numbers must start with a letter. In addition,`-` can only be used at most once and cannot be placed at the beginning or the end of the payment numbers.  | [optional] 
-**period** | **String** | The frequency for the payment collection since the `startDate`.  **Note:** - Thie field is required when `items` is not specified. - This field will be ignored when `items` is specified. - If `startDate` is `30` or `31` and `period` is `Monthly`, when in February, payment schedule will use the last day of February for payment collection.  | [optional] 
-**prepayment** | **Boolean** | Indicates whether the payments created by the payment schedule will be used as reserved payments. This field will only be available if the prepaid cash drawdown permission is enabled. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.  | [optional] 
-**run_hour** | **Number** | Specifies at which hour in the day in the tenant’s time zone when this payment will be collected. Available values: `[0,1,2,~,22,23]`.  **Note:** - If the time difference between your tenant’s timezone and the timezone where Zuora servers are is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half hour later than your scheduled time. - If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs. - This field is optional. The default value is `0`. - This field will be ignored when `items` is specified.  | [optional] 
-**standalone** | **Boolean** | Indicate whether the payments created by the payment schedule are standalone payments or not. When setting to `true`, standalone payments will be created. When setting to `false`, you can either specify a billing document, or not specifying any billing documents. In the later case, unapplied payments will be created. If set to `null`, standalone payment will be created.  **Note**:  - This field is only available if the Standalone Payment is enabled. Do not include this field if Standalone Payment is not enabled. - If Standalone Payment is enabled, default value is `true`.  | [optional] 
+**occurrences** | **Number** | The number of payment schedule item to be created. Maximum value is 1000.   **Note:**  - This field is required when `items` is not specified.  - This field will be ignored when `items` is specified. | [optional] 
+**payment_gateway_id** | **String** | ID of the payment gateway.   **Note:**  - This field is optional. The default value is the account's default payment gateway ID. If no payment gateway ID is found on the cusotmer account level, the default value will be the tenant's default payment gateway ID.  - This field will be ignored when `items` is specified. | [optional] 
+**payment_method_id** | **String** | ID of the payment method.   **Note:**  - This field is optional. The default value is the account's default payment method ID.  - This field will be ignored when `items` is specified. | [optional] 
+**payment_option** | [**[PaymentSchedulePaymentOptionFields]**](PaymentSchedulePaymentOptionFields.md) | Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.    Here is an example:  ```  \"paymentOption\": [   {     \"type\": \"GatewayOptions\",     \"detail\": {       \"SecCode\":\"WEB\"     }   } ]  ```   `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.   To enable this field, submit a request at [Zuora Global Support](https://support.zuora.com/). This field is only available if `zuora-version` is set to `337.0` or later. | [optional] 
+**payment_schedule_number** | **String** | You can use this field to specify the number of the payment schedule.  Only characters from the following sets are allowed: A-Z, a-z, 0-9, and `-`.   Payment numbers must start with a letter. In addition,`-` can only be used at most once and cannot be placed at the beginning or the end of the payment numbers. | [optional] 
+**period** | **String** | The frequency for the payment collection since the `startDate`.   **Note:**  - Thie field is required when `items` is not specified.  - This field will be ignored when `items` is specified.  - If `startDate` is `30` or `31` and `period` is `Monthly`, when in February, payment schedule will use the last day of February for payment collection. | [optional] 
+**prepayment** | **Boolean** | Indicates whether the payments created by the payment schedule will be used as reserved payments. This field will only be available if the prepaid cash drawdown permission is enabled. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information. | [optional] 
+**run_hour** | **Number** | Specifies at which hour in the day in the tenant’s time zone when this payment will be collected. Available values: `[0,1,2,~,22,23]`.   **Note:**  - If the time difference between your tenant’s timezone and the timezone where Zuora servers are is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half hour later than your scheduled time.  - If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.  - This field is optional. The default value is `0`.  - This field will be ignored when `items` is specified. | [optional] 
+**standalone** | **Boolean** | Indicate whether the payments created by the payment schedule are standalone payments or not. When setting to `true`, standalone payments will be created. When setting to `false`, you can either specify a billing document, or not specifying any billing documents. In the later case, unapplied payments will be created. If set to `null`, standalone payment will be created.   **Note**:   - This field is only available if the Standalone Payment is enabled. Do not include this field if Standalone Payment is not enabled.  - If Standalone Payment is enabled, default value is `true`. | [optional] 
 **start_date** | **String** | The date for the first payment collection.  **Note:** - This field is required when `items` is not specified. - This field will be ignored when `items` is specified.  | [optional] 
-**total_amount** | **Number** | The total amount of that the payment schedule will collect. This field is only available for recurring payment schedules.   **Note**: - When creating recurring payment schedules, there are 2 options to specify amounts:      - Specify `totalAmount` and `occurrences`, `amount` will be calculated.   - Specify `amount` and `occurrences`, `totalAmount` will be calculated.      You must specify either `totalAmount` or `amount`. Specifying both fields at the same time is not allowed. - If the Standalone Payments feature is enabled and `standalone` is set to `true` for the payment schedule, `totalAmount` will be ignored.  | [optional] 
+**total_amount** | **Number** | The total amount of that the payment schedule will collect. This field is only available for recurring payment schedules.    **Note**:  - When creating recurring payment schedules, there are 2 options to specify amounts:      - Specify `totalAmount` and `occurrences`, `amount` will be calculated.   - Specify `amount` and `occurrences`, `totalAmount` will be calculated.      You must specify either `totalAmount` or `amount`. Specifying both fields at the same time is not allowed. - If the Standalone Payments feature is enabled and `standalone` is set to `true` for the payment schedule, `totalAmount` will be ignored. | [optional] 
 
 
 

package/docs/CreatePaymentScheduleRequestItems.md

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

package/docs/CreatePaymentSessionInvoice.md

@@ -4,6 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**invoice_number** | **String** | The number of the invoice that the payment is applied to. For example, `INV00000001`.   | [optional] 
+**invoice_number** | **String** | The number of the invoice that the payment is applied to. For example, `INV00000001`.  | [optional] 
 
 

package/docs/CreatePaymentSessionRequest.md

@@ -4,14 +4,14 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**account_id** | **String** | The ID of the customer account in Zuora that is associated with this payment method.  | [optional] 
+**account_id** | **String** | The ID of the customer account in Zuora that is associated with this payment method. | [optional] 
 **amount** | **Number** | The amount of the payment.  This field is required if `processPayment` is `true`.  | [optional] 
-**auth_amount** | **Number** | The authorization amount for the payment method. Specify a value greater than 0.  This field is required if `processPayment` is false.  | [optional] 
-**currency** | **String** | The currency of the payment in the format of the three-character ISO currency code.  | [optional] 
+**auth_amount** | **Number** | The authorization amount for the payment method. Specify a value greater than 0.   This field is required if `processPayment` is false. | [optional] 
+**currency** | **String** | The currency of the payment in the format of the three-character ISO currency code. | [optional] 
 **gateway_options** | [**GatewayOptions**](GatewayOptions.md) |  | [optional] 
-**payment_gateway** | **String** | The ID of the payment gateway instance configured in Zuora that will process the payment, such as `e884322ab8c711edab030242ac120004`.  | [optional] 
-**process_payment** | **Boolean** | Indicate whether a payment should be processed after creating the payment method.  If this field is set to `true`, you must specify the `amount` field.  If this field is set to `false`, you must specify the `authAmount` field. The payment method will be verified through the payment gateway instance specified in the `paymentGateway` field.  | [optional] [default to true]
-**store_payment_method** | **Boolean** | true indicates that the payment method will be stored in Zuora and will be used in subsequent recurring payments. false indicates that the payment method will not be stored in Zuora. End-customers need to be brought back on-session to authenticate the payment.  | [optional] [default to true]
+**payment_gateway** | **String** | The ID of the payment gateway instance configured in Zuora that will process the payment, such as `e884322ab8c711edab030242ac120004`. | [optional] 
+**process_payment** | **Boolean** | Indicate whether a payment should be processed after creating the payment method.   If this field is set to `true`, you must specify the `amount` field.   If this field is set to `false`, you must specify the `authAmount` field. The payment method will be verified through the payment gateway instance specified in the `paymentGateway` field. | [optional] [default to true]
+**store_payment_method** | **Boolean** | true indicates that the payment method will be stored in Zuora and will be used in subsequent recurring payments. false indicates that the payment method will not be stored in Zuora. End-customers need to be brought back on-session to authenticate the payment. | [optional] [default to true]
 **invoices** | [**[CreatePaymentSessionInvoice]**](CreatePaymentSessionInvoice.md) | Container for invoices. The maximum number of invoices is 1,000.  | [optional] 
 
 

package/docs/CreatePaymentSessionResponse.md

@@ -4,6 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**token** | **String** | The token for the payment session data. Send the token back to your client side for identifying your website to Zuora.  For more information, see [Set up Apple Pay through the JavaScript SDK approach](https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B_Define_Payment_Methods/Set_up_Apple_Pay_for_gateway_integrations_other_than_Adyen_Integration_v2.0).  | [optional] 
+**token** | **String** | The token for the payment session data. Send the token back to your client side for identifying your website to Zuora.   For more information, see [Set up Apple Pay through the JavaScript SDK approach](https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B_Define_Payment_Methods/Set_up_Apple_Pay_for_gateway_integrations_other_than_Adyen_Integration_v2.0). | [optional] 
 
 

package/docs/CreateProductRatePlanChargeRequest.md

@@ -18,10 +18,10 @@ Name | Type | Description | Notes
 **rev_rec_template_type__ns** | **String** | Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
 **subsidiary__ns** | **String** | Subsidiary associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
 **sync_date__ns** | **String** | Date when the product rate plan charge was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**product_rate_plan_id** | **String** | The ID of the product rate plan associated with this product rate plan charge.  | 
-**accounting_code** | **String** | The accounting code for the charge. Accounting codes group transactions that contain similar accounting attributes.  | [optional] 
+**product_rate_plan_id** | **String** | The ID of the product rate plan associated with this product rate plan charge. | 
+**accounting_code** | **String** | The accounting code for the charge. Accounting codes group transactions that contain similar accounting attributes. | [optional] 
 **apply_discount_to** | [**ApplyDiscountTo**](ApplyDiscountTo.md) |  | [optional] 
-**bill_cycle_day** | **Number** | Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month customer is billed. The BCD value in the account can override the BCD in this object.  **Character limit**: 2  **Values**: a valid BCD integer, 1 - 31  | [optional] 
+**bill_cycle_day** | **Number** | Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month customer is billed. The BCD value in the account can override the BCD in this object.   **Character limit**: 2   **Values**: a valid BCD integer, 1 - 31 | [optional] 
 **bill_cycle_type** | [**BillCycleType**](BillCycleType.md) |  | 
 **billing_period** | [**BillingPeriodProductRatePlanChargeRest**](BillingPeriodProductRatePlanChargeRest.md) |  | 
 **billing_period_alignment** | [**BillingPeriodAlignmentProductRatePlanChargeRest**](BillingPeriodAlignmentProductRatePlanChargeRest.md) |  | [optional] 
@@ -32,59 +32,59 @@ Name | Type | Description | Notes
 **charge_type** | [**ChargeType**](ChargeType.md) |  | 
 **commitment_type** | [**CommitmentType**](CommitmentType.md) |  | [optional] 
 **credit_option** | [**PrepaidDrawdownCreditOption**](PrepaidDrawdownCreditOption.md) |  | [optional] 
-**default_quantity** | **Number** | The default quantity of units, such as the number of authors in a hosted wiki service. This field is required if you use a per-unit pricing model.   **Character limit**: 16  **Values**: a valid quantity value.   **Note:** When the `ChargeModel` field is set to `Tiered Pricing` or `Volume Pricing`, if this field is not specified, the value will default to `0`.  | [optional] 
-**deferred_revenue_account** | **String** | The name of the deferred revenue account for this charge.  This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).   | [optional] 
+**default_quantity** | **Number** | The default quantity of units, such as the number of authors in a hosted wiki service. This field is required if you use a per-unit pricing model.    **Character limit**: 16   **Values**: a valid quantity value.    **Note:** When the `ChargeModel` field is set to `Tiered Pricing` or `Volume Pricing`, if this field is not specified, the value will default to `0`. | [optional] 
+**deferred_revenue_account** | **String** | The name of the deferred revenue account for this charge.   This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).  | [optional] 
 **delivery_schedule** | [**DeliveryScheduleProductRatePlanCharge**](DeliveryScheduleProductRatePlanCharge.md) |  | [optional] 
 **description** | **String** | A description of the charge.  | [optional] 
 **discount_level** | [**DiscountLevel**](DiscountLevel.md) |  | [optional] 
-**drawdown_rate** | **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.  To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.  The [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). See [Fields related to Prepaid with Drawdown](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/ProductRatePlanCharge#Fields_related_to_Prepaid_with_Drawdown) for more information.  | [optional] 
-**drawdown_uom** | **String** | **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.  To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.   Unit of measurement for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).   | [optional] 
+**drawdown_rate** | **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.   To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.   The [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). See [Fields related to Prepaid with Drawdown](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/ProductRatePlanCharge#Fields_related_to_Prepaid_with_Drawdown) for more information. | [optional] 
+**drawdown_uom** | **String** | **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.   To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.    Unit of measurement for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).  | [optional] 
 **end_date_condition** | [**EndDateConditionProductRatePlanChargeRest**](EndDateConditionProductRatePlanChargeRest.md) |  | [optional] 
-**exclude_item_billing_from_revenue_accounting** | **Boolean** | The flag to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.  **Notes**:    - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.   - This field is only available if you have the Billing - Revenue Integration feature enabled.   | [optional] [default to false]
-**exclude_item_booking_from_revenue_accounting** | **Boolean** | The flag to exclude the related rate plan charges and order line items from revenue accounting.  **Notes**:    - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.   - This field is only available if you have the Billing - Revenue Integration feature enabled.   | [optional] [default to false]
-**revenue_recognition_timing** | **String** | This field is used to dictate the type of revenue recognition timing.  | [optional] 
-**revenue_amortization_method** | **String** | This field is used to dictate the type of revenue amortization method.  | [optional] 
+**exclude_item_billing_from_revenue_accounting** | **Boolean** | The flag to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.   **Notes**:    - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.   - This field is only available if you have the Billing - Revenue Integration feature enabled.  | [optional] [default to false]
+**exclude_item_booking_from_revenue_accounting** | **Boolean** | The flag to exclude the related rate plan charges and order line items from revenue accounting.   **Notes**:    - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.   - This field is only available if you have the Billing - Revenue Integration feature enabled.  | [optional] [default to false]
+**revenue_recognition_timing** | **String** | This field is used to dictate the type of revenue recognition timing. | [optional] 
+**revenue_amortization_method** | **String** | This field is used to dictate the type of revenue amortization method. | [optional] 
 **included_units** | **Number** | Specifies the number of units in the base set of units.  **Character limit**: 16  **Values**: a positive decimal value  | [optional] 
-**is_prepaid** | **Boolean** | **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.  To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.   Indicates whether this charge is a prepayment (topup) charge or a drawdown charge. Values: `true` or `false`.  | [optional] 
-**is_rollover** | **Boolean** | **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.  To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.  The value is either \"True\" or \"False\". It determines whether the rollover fields are needed.  | [optional] 
-**is_stacked_discount** | **Boolean** | **Note**: This field is only applicable to the Discount - Percentage charge model.  To use this field, you must set the `X-Zuora-WSDL-Version` request header to 130 or higher. Otherwise, an error occurs.  This field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows:   - `True`: This is a stacked discount, which should be calculated by stacking with other discounts.   - `False`: This is not a stacked discount, which should be calculated in sequence with other discounts.  For more information, see [Stacked discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models).  | [optional] 
+**is_prepaid** | **Boolean** | **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.   To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.    Indicates whether this charge is a prepayment (topup) charge or a drawdown charge. Values: `true` or `false`. | [optional] 
+**is_rollover** | **Boolean** | **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.   To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.   The value is either \"True\" or \"False\". It determines whether the rollover fields are needed. | [optional] 
+**is_stacked_discount** | **Boolean** | **Note**: This field is only applicable to the Discount - Percentage charge model.   To use this field, you must set the `X-Zuora-WSDL-Version` request header to 130 or higher. Otherwise, an error occurs.   This field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows:   - `True`: This is a stacked discount, which should be calculated by stacking with other discounts.   - `False`: This is not a stacked discount, which should be calculated in sequence with other discounts.  For more information, see [Stacked discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models). | [optional] 
 **legacy_revenue_reporting** | **Boolean** |  | [optional] 
 **list_price_base** | [**ListPriceBase**](ListPriceBase.md) |  | [optional] 
-**min_quantity** | **Number** | Specifies the minimum number of units for this charge. Use this field and the `MaxQuantity` field to create a range of units allowed in a product rate plan charge.  **Character limit**: 16  **Values**: a positive decimal value  | [optional] 
-**max_quantity** | **Number** | Specifies the maximum number of units for this charge. Use this field and the `MinQuantity` field to create a range of units allowed in a product rate plan charge.  **Character limit**: 16  **Values**: a positive decimal value  | [optional] 
+**min_quantity** | **Number** | Specifies the minimum number of units for this charge. Use this field and the `MaxQuantity` field to create a range of units allowed in a product rate plan charge.   **Character limit**: 16   **Values**: a positive decimal value | [optional] 
+**max_quantity** | **Number** | Specifies the maximum number of units for this charge. Use this field and the `MinQuantity` field to create a range of units allowed in a product rate plan charge.   **Character limit**: 16   **Values**: a positive decimal value | [optional] 
 **name** | **String** | The name of the product rate plan charge.  | 
-**number_of_period** | **Number** | Specifies the number of periods to use when calculating charges in an overage smoothing charge model. The valid value is a positive whole number.  | [optional] 
+**number_of_period** | **Number** | Specifies the number of periods to use when calculating charges in an overage smoothing charge model. The valid value is a positive whole number. | [optional] 
 **overage_calculation_option** | [**OverageCalculationOption**](OverageCalculationOption.md) |  | [optional] 
 **overage_unused_units_credit_option** | [**OverageUnusedUnitsCreditOption**](OverageUnusedUnitsCreditOption.md) |  | [optional] 
 **prepaid_operation_type** | [**PrepaidOperationType**](PrepaidOperationType.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.  To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.   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.  | [optional] 
-**prepaid_total_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.  To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.   The total amount of units that end customers can use during a validity period when they subscribe to a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).  | [optional] 
-**prepaid_uom** | **String** | **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.  To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.  Unit of measurement for a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).  | [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.   To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.    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. | [optional] 
+**prepaid_total_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.   To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.    The total amount of units that end customers can use during a validity period when they subscribe to a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). | [optional] 
+**prepaid_uom** | **String** | **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.   To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.   Unit of measurement for a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). | [optional] 
 **price_change_option** | [**PriceChangeOption**](PriceChangeOption.md) |  | [optional] 
 **price_increase_option** | [**PriceIncreaseOption**](PriceIncreaseOption.md) |  | [optional] 
-**price_increase_percentage** | **Number** | Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the value to `SpecificPercentageValue`.  **Character limit**: 16  **Values**: a decimal value between -100 and 100  | [optional] 
-**product_rate_plan_charge_number** | **String** | The natural key of the product rate plan charge.  **Values**:    - leave null for automatically generated string   - an alphanumeric string of 100 characters or fewer  **Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later.  | [optional] 
+**price_increase_percentage** | **Number** | Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the value to `SpecificPercentageValue`.   **Character limit**: 16   **Values**: a decimal value between -100 and 100 | [optional] 
+**product_rate_plan_charge_number** | **String** | The natural key of the product rate plan charge.   **Values**:    - leave null for automatically generated string   - an alphanumeric string of 100 characters or fewer  **Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later. | [optional] 
 **product_rate_plan_charge_tier_data** | [**ProductRatePlanChargeTierData**](ProductRatePlanChargeTierData.md) |  | 
 **rating_group** | [**RatingGroup**](RatingGroup.md) |  | [optional] 
 **recognized_revenue_account** | **String** | The name of the recognized revenue account for this charge.   - Required when the Allow Blank Accounting Code setting is No.   - Optional when the Allow Blank Accounting Code setting is Yes.    This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).   | [optional] 
-**rev_rec_code** | **String** | Associates this product rate plan charge with a specific revenue recognition code.  | [optional] 
+**rev_rec_code** | **String** | Associates this product rate plan charge with a specific revenue recognition code. | [optional] 
 **rev_rec_trigger_condition** | [**RevRecTriggerConditionProductRatePlanChargeRest**](RevRecTriggerConditionProductRatePlanChargeRest.md) |  | [optional] 
 **revenue_recognition_rule_name** | [**RevenueRecognitionRuleName**](RevenueRecognitionRuleName.md) |  | [optional] 
 **rollover_apply** | [**RolloverApply**](RolloverApply.md) |  | [optional] 
-**rollover_periods** | **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.  To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.  This field defines the number of rollover periods, it is restricted to 3.  | [optional] 
+**rollover_periods** | **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.   To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.   This field defines the number of rollover periods, it is restricted to 3. | [optional] 
 **smoothing_model** | [**SmoothingModel**](SmoothingModel.md) |  | [optional] 
-**specific_billing_period** | **Number** | Customizes the number of months or weeks for the charges billing period. This field is required if you set the value of the BillingPeriod field to `Specific Months` or `Specific Weeks`. The valid value is a positive integer.  | [optional] 
-**specific_list_price_base** | **Number** | The number of months for the list price base of the charge. This field is required if you set the value of the `ListPriceBase` field to `Per Specific Months`.  **Notes**:    - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.   - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `129` or later. Otherwise, an error occurs.   - The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`.  | [optional] 
-**tax_code** | **String** | Specifies the tax code for taxation rules. Required when the Taxable field is set to `True`.  **Note**: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`.  | [optional] 
+**specific_billing_period** | **Number** | Customizes the number of months or weeks for the charges billing period. This field is required if you set the value of the BillingPeriod field to `Specific Months` or `Specific Weeks`.  The valid value is a positive integer. | [optional] 
+**specific_list_price_base** | **Number** | The number of months for the list price base of the charge. This field is required if you set the value of the `ListPriceBase` field to `Per Specific Months`.   **Notes**:    - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.   - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `129` or later. Otherwise, an error occurs.   - The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`. | [optional] 
+**tax_code** | **String** | Specifies the tax code for taxation rules. Required when the Taxable field is set to `True`.   **Note**: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`. | [optional] 
 **tax_mode** | [**TaxMode**](TaxMode.md) |  | [optional] 
-**taxable** | **Boolean** | Determines whether the charge is taxable. When set to `True`, the TaxMode and TaxCode fields are required when creating or updating th ProductRatePlanCharge object.  **Character limit**: 5  **Values**: `True`, `False`  **Note**: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`.  | [optional] 
+**taxable** | **Boolean** | Determines whether the charge is taxable. When set to `True`, the TaxMode and TaxCode fields are required when creating or updating th ProductRatePlanCharge object.   **Character limit**: 5   **Values**: `True`, `False`   **Note**: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`. | [optional] 
 **trigger_event** | [**TriggerEventProductRatePlanChargeRest**](TriggerEventProductRatePlanChargeRest.md) |  | 
-**UOM** | **String** | Specifies a configured unit to measure usage.   **Note**: You must specify this field when creating the following charge models:   - Per Unit Pricing   - Volume Pricing   - Overage Pricing   - Tiered Pricing   - Tiered with Overage Pricing  | [optional] 
-**up_to_periods** | **Number** | Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends.  **Character limit**: 5  **Values**: a whole number between 0 and 65535, exclusive  **Notes**:   - You must use this field together with the `UpToPeriodsType` field to specify the time period. This field is applicable only when the `EndDateCondition` field is set to `FixedPeriod`.    - If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end.  | [optional] 
+**UOM** | **String** | Specifies a configured unit to measure usage.    **Note**: You must specify this field when creating the following charge models:   - Per Unit Pricing   - Volume Pricing   - Overage Pricing   - Tiered Pricing   - Tiered with Overage Pricing | [optional] 
+**up_to_periods** | **Number** | Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends.   **Character limit**: 5   **Values**: a whole number between 0 and 65535, exclusive   **Notes**:   - You must use this field together with the `UpToPeriodsType` field to specify the time period. This field is applicable only when the `EndDateCondition` field is set to `FixedPeriod`.    - If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end. | [optional] 
 **up_to_periods_type** | [**UpToPeriodsTypeProductRatePlanChargeRest**](UpToPeriodsTypeProductRatePlanChargeRest.md) |  | [optional] 
 **usage_record_rating_option** | [**UsageRecordRatingOption**](UsageRecordRatingOption.md) |  | [optional] 
-**use_discount_specific_accounting_code** | **Boolean** | Determines whether to define a new accounting code for the new discount charge.  **Character limit**: 5  **Values**: `True`, `False`  | 
-**use_tenant_default_for_price_change** | **Boolean** | Applies the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal.   **Character limit**: 5  **Values**: `true`, `false`  | [optional] 
+**use_discount_specific_accounting_code** | **Boolean** | Determines whether to define a new accounting code for the new discount charge.   **Character limit**: 5   **Values**: `True`, `False` | 
+**use_tenant_default_for_price_change** | **Boolean** | Applies the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal.    **Character limit**: 5   **Values**: `true`, `false` | [optional] 
 **validity_period_type** | [**ValidityPeriodType**](ValidityPeriodType.md) |  | [optional] 
 **weekly_bill_cycle_day** | [**WeeklyBillCycleDay**](WeeklyBillCycleDay.md) |  | [optional] 
 

package/docs/CreateProductRatePlanRequest.md

@@ -16,15 +16,15 @@ Name | Type | Description | Notes
 **price__ns** | **String** | Price associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
 **subsidiary__ns** | **String** | Subsidiary associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
 **sync_date__ns** | **String** | Date when the product rate plan was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**product_rate_plan_number** | **String** | The natural key of the product rate plan.  **Possible values**:    - leave null for automatically generated string   - an alphanumeric string of 100 characters or fewer  **Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later.  | [optional] 
-**name** | **String** | The name of the product rate plan. The name doesn't have to be unique in a Product Catalog, but the name has to be unique within a product.  | 
+**product_rate_plan_number** | **String** | The natural key of the product rate plan.   **Possible values**:    - leave null for automatically generated string   - an alphanumeric string of 100 characters or fewer  **Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later. | [optional] 
+**name** | **String** | The name of the product rate plan. The name doesn't have to be unique in a Product Catalog, but the name has to be unique within a product. | 
 **product_id** | **String** | The ID of the product that contains the product rate plan.  | 
-**active_currencies** | **[String]** | A list of 3-letter currency codes representing active currencies for the product rate plan. Use a comma to separate each currency code.  When creating a product rate plan, you can use this field to specify default currency and at most four other active currencies.  | [optional] 
+**active_currencies** | **[String]** | A list of 3-letter currency codes representing active currencies for the product rate plan. Use a comma to separate each currency code.   When creating a product rate plan, you can use this field to specify default currency and at most four other active currencies. | [optional] 
 **description** | **String** | A description of the product rate plan.  | [optional] 
-**effective_start_date** | **String** | The date when the product rate plan becomes available and can be subscribed to, in `yyyy-mm-dd` format.  | [optional] 
-**effective_end_date** | **String** | The date when the product rate plan expires and can't be subscribed to, in `yyyy-mm-dd` format.  | [optional] 
+**effective_start_date** | **String** | The date when the product rate plan becomes available and can be subscribed to, in `yyyy-mm-dd` format. | [optional] 
+**effective_end_date** | **String** | The date when the product rate plan expires and can't be subscribed to, in `yyyy-mm-dd` format. | [optional] 
 **external_rate_plan_ids** | **[String]** | The unique identifier for the product rate plan in a third-party store. This field is used to represent a rate plan created through third-party stores.  | [optional] 
 **external_id_source_system** | **String** | The combination of `externallyManagedPlanId` and `externalIdSourceSystem` is 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] 
-**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.  **Notes**:    - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `116` or later. Otherwise, an error occurs.   - This field 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 [Zuora Global Support](http://support.zuora.com/).  | [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.   **Notes**:    - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `116` or later. Otherwise, an error occurs.   - This field 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 [Zuora Global Support](http://support.zuora.com/). | [optional] 
 
 

package/docs/CreateProductRequest.md

@@ -9,12 +9,12 @@ Name | Type | Description | Notes
 **item_type__ns** | [**ProductObjectNSFieldsItemTypeNS**](ProductObjectNSFieldsItemTypeNS.md) |  | [optional] 
 **sync_date__ns** | **String** | Date when the product was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
 **SKU** | **String** | The unique SKU for the product.  **Values**:    - leave null for automatically generated string   - an alphanumeric string of 50 characters or fewer  | [optional] 
-**name** | **String** | The name of the product. This information is displayed in the product catalog pages in the web-based UI.  | 
-**product_number** | **String** | The natural key of the product.  **Values**:    - leave null for automatically generated string   - an alphanumeric string of 100 characters or fewer  **Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later.  | [optional] 
+**name** | **String** | The name of the product. This information is displayed in the product catalog pages in the web-based UI. | 
+**product_number** | **String** | The natural key of the product.   **Values**:    - leave null for automatically generated string   - an alphanumeric string of 100 characters or fewer  **Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later. | [optional] 
 **category** | [**ProductCategory**](ProductCategory.md) |  | [optional] 
 **description** | **String** | A description of the product.  | [optional] 
-**effective_start_date** | **String** | The date when the product becomes available and can be subscribed to, in `yyyy-mm-dd` format.  | 
-**effective_end_date** | **String** | The date when the product expires and can't be subscribed to anymore, in `yyyy-mm-dd` format.  | 
-**allow_feature_changes** | **Boolean** | Controls whether to allow your users to add or remove features while creating or amending a subscription.  **Values**: true, false (default)  | [optional] 
+**effective_start_date** | **String** | The date when the product becomes available and can be subscribed to, in `yyyy-mm-dd` format. | 
+**effective_end_date** | **String** | The date when the product expires and can't be subscribed to anymore, in `yyyy-mm-dd` format. | 
+**allow_feature_changes** | **Boolean** | Controls whether to allow your users to add or remove features while creating or amending a subscription.   **Values**: true, false (default) | [optional] 
 
 

package/docs/CreateRSASignatureRequest.md

@@ -4,40 +4,40 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**IBAN** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**account_id** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**authorization_amount** | **Number** | An optional client parameter that can be used for validating client-side HPM parameters.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**bank_branch_code** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**bank_check_digit** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**bank_city** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**bank_postal_code** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**bank_street_name** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**bank_street_number** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**business_identification_code** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**city_black_list** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for credit cards.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**city_white_list** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for credit cards.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**currency** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**device_session_id** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**gateway_name** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**id** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**key** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**locale** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**max_consecutive_payment_failures** | **Number** | An optional client parameter that can be used for validating client-side HPM parameters.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
+**IBAN** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**account_id** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**authorization_amount** | **Number** | An optional client parameter that can be used for validating client-side HPM parameters.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**bank_branch_code** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**bank_check_digit** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**bank_city** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**bank_postal_code** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**bank_street_name** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**bank_street_number** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**business_identification_code** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**city_black_list** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for credit cards.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**city_white_list** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for credit cards.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**currency** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**device_session_id** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**gateway_name** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**id** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**key** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**locale** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**max_consecutive_payment_failures** | **Number** | An optional client parameter that can be used for validating client-side HPM parameters.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
 **method** | **String** | The type of the request. Set it to Post.  | 
-**page_id** | **String** | The page id of your Payment Pages 2.0 form. Click **Show Page Id** next to the Payment Page name in the Hosted Page List to retrieve the page id.  | 
-**param_gw_options__option** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**param_supported_types** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for credit cards.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**passthrough_12345** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  Note: Although up to 15 passthrough parameters can be supported when passing in your client parameters, only the first 5 parameters are used for signature generation and validation.  | [optional] 
-**payment_gateway** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**payment_retry_window** | **Number** | An optional client parameter that can be used for validating client-side HPM parameters.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**pm_id** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for credit cards.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**signature** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**signature_type** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**style** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**submit_enabled** | **Boolean** | An optional client parameter that can be used for validating client-side HPM parameters.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**tenant_id** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**token** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
-**uri** | **String** | The URL that the Payment Page will be served from. * For US Cloud 1 Production environment: Use https://na.zuora.com/apps/PublicHostedPageLite.do * For US Cloud 1 Sandbox environment: Use https://sandbox.na.zuora.com/apps/PublicHostedPageLite.d * For US Cloud 2 Production environment: Use https://www.zuora.com/apps/PublicHostedPageLite.do * For US Cloud 2 API Sandbox environment: Use https://apisandbox.zuora.com/apps/PublicHostedPageLite.do * For US Central Sandbox environment: Use https://test.zuora.com/apps/PublicHostedPageLite.do * For EU Cloud Production environment: Use https://eu.zuora.com/apps/PublicHostedPageLite.do * For EU Cloud Sandbox environment: Use https://sandbox.eu.zuora.com/apps/PublicHostedPageLite.do * For EU Central Sandbox environment: Use https://test.eu.zuora.com/apps/PublicHostedPageLite.do  | 
-**use_default_retry_rule** | **Boolean** | An optional client parameter that can be used for validating client-side HPM parameters.  See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)  and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)  for details.  | [optional] 
+**page_id** | **String** | The page id of your Payment Pages 2.0 form. Click **Show Page Id** next to the Payment Page name in the Hosted Page List to retrieve the page id. | 
+**param_gw_options__option** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**param_supported_types** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for credit cards.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**passthrough_12345** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details.   Note: Although up to 15 passthrough parameters can be supported when passing in your client parameters, only the first 5 parameters are used for signature generation and validation. | [optional] 
+**payment_gateway** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**payment_retry_window** | **Number** | An optional client parameter that can be used for validating client-side HPM parameters.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**pm_id** | **String** | An optional client parameter that can be used for validating client-side HPM parameters specific for credit cards.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**signature** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**signature_type** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**style** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**submit_enabled** | **Boolean** | An optional client parameter that can be used for validating client-side HPM parameters.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**tenant_id** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**token** | **String** | An optional client parameter that can be used for validating client-side HPM parameters.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
+**uri** | **String** | The URL that the Payment Page will be served from.  * For US Cloud 1 Production environment: Use https://na.zuora.com/apps/PublicHostedPageLite.do  * For US Cloud 1 Sandbox environment: Use https://sandbox.na.zuora.com/apps/PublicHostedPageLite.d  * For US Cloud 2 Production environment: Use https://www.zuora.com/apps/PublicHostedPageLite.do  * For US Cloud 2 API Sandbox environment: Use https://apisandbox.zuora.com/apps/PublicHostedPageLite.do  * For US Central Sandbox environment: Use https://test.zuora.com/apps/PublicHostedPageLite.do  * For EU Cloud Production environment: Use https://eu.zuora.com/apps/PublicHostedPageLite.do  * For EU Cloud Sandbox environment: Use https://sandbox.eu.zuora.com/apps/PublicHostedPageLite.do  * For EU Central Sandbox environment: Use https://test.eu.zuora.com/apps/PublicHostedPageLite.do | 
+**use_default_retry_rule** | **Boolean** | An optional client parameter that can be used for validating client-side HPM parameters.   See [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0)   and [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters)   for details. | [optional] 
 
 

package/docs/CreateRamp.md

@@ -4,10 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**charges** | [**[RampChargeRequest]**](RampChargeRequest.md) | Container for the rate plan charges that are considered as part of the ramp deal.  * If this field is not specified, all the one-time and recurring regular charges of the new subscription are automatically considered as part of the ramp deal. * If this field is specified, either 'chargeNumber' or 'uniqueToken' must be specified.  | [optional] 
-**_delete** | **Boolean** | Whether to remove the ramp definition from the new subscription. If you want to remove the ramp definition, this field is the only required field for the `ramp` object.    | [optional] 
+**charges** | [**[RampChargeRequest]**](RampChargeRequest.md) | Container for the rate plan charges that are considered as part of the ramp deal.   * If this field is not specified, all the one-time and recurring regular charges of the new subscription are automatically considered as part of the ramp deal.  * If this field is specified, either 'chargeNumber' or 'uniqueToken' must be specified. | [optional] 
+**_delete** | **Boolean** | Whether to remove the ramp definition from the new subscription. If you want to remove the ramp definition, this field is the only required field for the `ramp` object.   | [optional] 
 **description** | **String** | The short description of the ramp. | [optional] 
-**intervals** | [**[RampIntervalRequest]**](RampIntervalRequest.md) | Container for the intervals that the ramp is split into in its timeline.   It is required when you want to create or update the ramp definition. The ramp intervals cannot have any overlap or gap between each other.  | [optional] 
+**intervals** | [**[RampIntervalRequest]**](RampIntervalRequest.md) | Container for the intervals that the ramp is split into in its timeline.    It is required when you want to create or update the ramp definition. The ramp intervals cannot have any overlap or gap between each other. | [optional] 
 **name** | **String** | The name of the ramp. | [optional] 
 
 

package/docs/CreateRefundwithAutoUnapply.md

@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 **second_refund_reference_id** | **String** | The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.  | [optional] 
 **soft_descriptor** | **String** | A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. | [optional] 
 **soft_descriptor_phone** | **String** | A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. | [optional] 
-**total_amount** | **Number** | The total amount of the refund.     - `Full Refund`: If the refund amount and debit memo/ invoice are not specified, then the payment will be unapplied completely, followed by processing a full refund.   - `Partial Refund`:        - If the total amount is specified, and the debit memo/invoice is not specified, you can unapply the refund amount from the available debit memo/invoice and refund the unapplied payment to the customer.        - If the total amount is specified, along with the debit memo and the invoice, you can unapply the applied payments from the mentioned invoices and debit memos, and refund the unapplied payments to customers.    | 
+**total_amount** | **Number** | The total amount of the refund.     - `Full Refund`: If the refund amount and debit memo/ invoice are not specified, then the payment will be unapplied completely, followed by processing a full refund.   - `Partial Refund`:        - If the total amount is specified, and the debit memo/invoice is not specified, you can unapply the refund amount from the available debit memo/invoice and refund the unapplied payment to the customer.  - If the total amount is specified, along with the debit memo and the invoice, you can unapply the applied payments from the mentioned invoices and debit memos, and refund the unapplied payments to customers.    | 
 **type** | [**RefundType**](RefundType.md) |  | 
 **refund_transaction_type** | [**RefundTransactionType**](RefundTransactionType.md) |  | [optional] 
 **write_off** | **Boolean** | Indicates whether to write off a document. | [optional] [default to false]

package/docs/CreateSequenceSetRequest.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **credit_memo** | [**CreditMemoEntityPrefix**](CreditMemoEntityPrefix.md) |  | 
 **debit_memo** | [**DebitMemoEntityPrefix**](DebitMemoEntityPrefix.md) |  | 
 **invoice** | [**InvoiceEntityPrefix**](InvoiceEntityPrefix.md) |  | 
-**name** | **String** | The name of the sequence set to configure for billing documents, payments, and refunds.  | 
+**name** | **String** | The name of the sequence set to configure for billing documents, payments, and refunds. | 
 **payment** | [**PaymentEntityPrefix**](PaymentEntityPrefix.md) |  | [optional] 
 **refund** | [**RefundEntityPrefix**](RefundEntityPrefix.md) |  | [optional] 
 

package/docs/CreateSequenceSetsRequest.md

@@ -4,6 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sequence_sets** | [**[CreateSequenceSetRequest]**](CreateSequenceSetRequest.md) | Array of sequence sets configured for billing documents, payments, and refunds.  | [optional] 
+**sequence_sets** | [**[CreateSequenceSetRequest]**](CreateSequenceSetRequest.md) | Array of sequence sets configured for billing documents, payments, and refunds. | [optional] 
 
 

package/docs/CreateSequenceSetsResponse.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sequence_sets** | [**[GetSequenceSetResponse]**](GetSequenceSetResponse.md) | Array of sequence sets configured for billing documents, payments, and refunds.  | [optional] 
+**sequence_sets** | [**[GetSequenceSetResponse]**](GetSequenceSetResponse.md) | Array of sequence sets configured for billing documents, payments, and refunds. | [optional] 
 **success** | **Boolean** | Indicates whether the call succeeded.  | [optional]