zuora-sdk-js 3.6.0 → 3.7.0

package/docs/GetProductRatePlanChargeResponse.md

@@ -5,10 +5,10 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | Object identifier. | [optional] 
-**product_rate_plan_id** | **String** | The ID of the product rate plan associated with this product rate plan charge.  | [optional] 
-**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. | [optional] 
+**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. StackedDiscount **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.  StackedDiscount **Character limit**: 2   **Values**: a valid BCD integer, 1 - 31 | [optional] 
 **bill_cycle_type** | [**BillCycleType**](BillCycleType.md) |  | [optional] 
 **billing_period** | [**BillingPeriodProductRatePlanChargeRest**](BillingPeriodProductRatePlanChargeRest.md) |  | [optional] 
 **billing_period_alignment** | [**BillingPeriodAlignmentProductRatePlanChargeRest**](BillingPeriodAlignmentProductRatePlanChargeRest.md) |  | [optional] 
@@ -18,63 +18,63 @@ Name | Type | Description | Notes
 **charge_model_configuration** | [**ChargeModelConfiguration**](ChargeModelConfiguration.md) |  | [optional] 
 **charge_type** | [**ChargeType**](ChargeType.md) |  | [optional] 
 **commitment_type** | [**CommitmentType**](CommitmentType.md) |  | [optional] 
-**created_by_id** | **String** | The automatically generated ID of the Zuora user who created the `ProductRatePlanCharge` object.  | [optional] 
+**created_by_id** | **String** | The automatically generated ID of the Zuora user who created the `ProductRatePlanCharge` object. | [optional] 
 **created_date** | **Date** | The date when the `ProductRatePlanCharge` object was created.  | [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 `ChargeModel` is `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 `ChargeModel` is `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.  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). Must be a positive number (>0).  | [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. 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.   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). Must be a positive number (>0). | [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.  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] 
-**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] 
+**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] 
+**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] 
 **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.  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_unbilled** | **Boolean** | This field is used to dictate how to perform the accounting during revenue recognition. **Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.  | [optional] 
-**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] 
+**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.   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_unbilled** | **Boolean** | This field is used to dictate how to perform the accounting during revenue recognition.  **Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases. | [optional] 
+**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] 
 **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.  | [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] 
+**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. The number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).  | [optional] 
-**prepaid_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. 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. 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] 
-**prepay_periods** | **Number** | The number of periods to which prepayment is set. **Note:** This field is only available if you already have the prepayment feature enabled.  The prepayment feature is deprecated and available only for backward compatibility. Zuora does not support enabling this feature anymore.  | [optional] 
+**prepaid_quantity** | **Number** | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.  The number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0). | [optional] 
+**prepaid_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.  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. 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] 
+**prepay_periods** | **Number** | The number of periods to which prepayment is set. **Note:** This field is only available if you already have the prepayment feature enabled.  The prepayment feature is deprecated and available only for backward compatibility. Zuora does not support enabling this feature anymore. | [optional] 
 **price_change_option** | [**PriceChangeOption**](PriceChangeOption.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] 
+**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] 
 **price_increase_option** | [**PriceIncreaseOption**](PriceIncreaseOption.md) |  | [optional] 
 **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] 
+**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_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** | **Object** | The number of months for the list price base of the charge. The value of this field is `null` if you do not 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** | **Object** | The number of months for the list price base of the charge. The value of this field is `null` if you do not 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) |  | [optional] 
-**UOM** | **String** | Specifies the units to measure usage.   **Note**: You must specify this field when creating the following charge models:   - Per Unit Pricing   - Volume Pricin   - 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 the units to measure usage.    **Note**: You must specify this field when creating the following charge models:   - Per Unit Pricing   - Volume Pricin   - 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] 
 **updated_by_id** | **String** | The ID of the last user to update the object.  | [optional] 
 **updated_date** | **Date** | The date when the object was last updated.  | [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`  | [optional] 
-**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` | [optional] 
+**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] 
 **rating_groups_operator_type** | [**RatingGroupsOperatorType**](RatingGroupsOperatorType.md) |  | [optional] 

package/docs/GetProductRatePlanChargeTierResponse.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **currency** | **String** | The valid code corresponding to the currency for the tier's price.  | [optional] 
 **ending_unit** | **Number** | The end number of a range of units for the tier.  **Character limit**: 16  **Values**: any positive decimal value  | [optional] 
 **id** | **String** | Object identifier. | [optional] 
-**price** | **Number** | The price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.  **Character limit**: 16  **Values**: a valid currency value  | [optional] 
+**price** | **Number** | The price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.   **Character limit**: 16   **Values**: a valid currency value | [optional] 
 **price_format** | [**PriceFormatProductRatePlanChargeTier**](PriceFormatProductRatePlanChargeTier.md) |  | [optional] 
 **starting_unit** | **Number** | The starting number of a range of units for the tier.  **Character limit**: 16  **Values**: any positive decimal value  | [optional] 
 **tier** | **Number** | A unique number that identifies the tier that the price applies to.  **Character limit**: 20  **Values**: automatically generated  | [optional] 

package/docs/GetProductResponse.md

@@ -10,10 +10,10 @@ Name | Type | Description | Notes
 **name** | **String** | Product name, up to 100 characters.  | [optional] 
 **category** | [**ProductCategory**](ProductCategory.md) |  | [optional] 
 **description** | **String** | Optional product description.  | [optional] 
-**effective_start_date** | **String** | The date when the product becomes available and can be subscribed to, as `yyyy-mm-dd`.  | [optional] 
-**effective_end_date** | **String** | The date when the product expires and cannot be subscribed to anymore, as `yyyy-mm-dd`.  | [optional] 
-**product_rate_plans** | **String** | URL to retrieve information about all product rate plans of a specific product. For example, `/v1/rateplan/40289f466463d683016463ef8b7301a0/productRatePlan`. If you want to view the product rate plan details, call [List all product rate plans of a product](https://www.zuora.com/developer/api-references/api/operation/Get_ProductRatePlans) #FIXME with the returned URL.  This field is in Zuora REST API version control. If you set the `zuora-version` request header to `230.0` or later, the value of this field is a URL. Zuora recommends that you use the latest behavior to retrieve product information.  If you do not set the `zuora-version` request header or you set this header to `229.0` or earlier, the value of this field is an array of product rate plan details. For more information about the array, see the response body of [List all product rate plans of a product](https://www.zuora.com/developer/api-references/api/operation/Get_ProductRatePlans). **Note**: The array contains a maximum of 300 product rate plans. Additionally, across all product rate plans, at most 300 product rate plan charges are returned.  | [optional] 
-**product_features** | [**[ProductFeature]**](ProductFeature.md) | Container for one or more product features. Only available when the following settings are enabled: - The Entitlements feature in your tenant - The Enable Feature Specification in Product and Subscriptions setting in Settings > Billing  | [optional] 
+**effective_start_date** | **String** | The date when the product becomes available and can be subscribed to, as `yyyy-mm-dd`. | [optional] 
+**effective_end_date** | **String** | The date when the product expires and cannot be subscribed to anymore, as `yyyy-mm-dd`. | [optional] 
+**product_rate_plans** | **String** | URL to retrieve information about all product rate plans of a specific product. For example, `/v1/rateplan/40289f466463d683016463ef8b7301a0/productRatePlan`. If you want to view the product rate plan details, call [List all product rate plans of a product](https://www.zuora.com/developer/api-references/api/operation/Get_ProductRatePlans) #FIXME with the returned URL.   This field is in Zuora REST API version control. If you set the `zuora-version` request header to `230.0` or later, the value of this field is a URL. Zuora recommends that you use the latest behavior to retrieve product information.   If you do not set the `zuora-version` request header or you set this header to `229.0` or earlier, the value of this field is an array of product rate plan details. For more information about the array, see the response body of [List all product rate plans of a product](https://www.zuora.com/developer/api-references/api/operation/Get_ProductRatePlans). **Note**: The array contains a maximum of 300 product rate plans. Additionally, across all product rate plans, at most 300 product rate plan charges are returned. | [optional] 
+**product_features** | [**[ProductFeature]**](ProductFeature.md) | Container for one or more product features. Only available when the following settings are enabled:  - The Entitlements feature in your tenant  - The Enable Feature Specification in Product and Subscriptions setting in Settings > Billing | [optional] 
 **tags** | **String** |  | [optional] 
 **integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
 **integration_status__ns** | **String** | Status of the product's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 

package/docs/GetProductsResponse.md

@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
 **products** | [**[Product]**](Product.md) | Container for one or more products:  | [optional] 
-**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent.  | [optional] 
+**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent. | [optional] 
 
 

package/docs/GetPublicNotificationDefinitionResponseFilterRule.md

@@ -4,12 +4,12 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**condition** | **String** | The filter rule conditions, written in [JEXL](http://commons.apache.org/proper/commons-jexl/). The rule might contain event context merge fields and data source merge fields. Data source merge fields must be from [the base object of the event or from the joined objects of the base object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects). Notifications with invalid merge fields will fail to evaluate, thus will not be invoked. For example, to trigger an event when an invoice is posted with the amount over 1000, you would define the following condition on the `Invoice` object:  ```changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000```  There are conventions and keywords you need to be aware of. For example:  * `changeType` is a keyword to specify what kind of change happened to the object. Allowed values are `INSERT`, `UPDATE` or `Delete`.  * `Invoice.Status` refers to field `Status` of the Zuora object `Invoice`.  * A variable with the `_old` suffix means it’s a previous value of the corresponding object field. The \"_old\" fields are only available on the base objects.  | [optional] 
+**condition** | **String** | The filter rule conditions, written in [JEXL](http://commons.apache.org/proper/commons-jexl/).  The rule might contain event context merge fields and data source merge fields. Data source merge fields must be from [the base object of the event or from the joined objects of the base object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects). Notifications with invalid merge fields will fail to evaluate, thus will not be invoked. For example, to trigger an event when an invoice is posted with the amount over 1000, you would define the following condition on the `Invoice` object:   ```changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000```   There are conventions and keywords you need to be aware of. For example:   * `changeType` is a keyword to specify what kind of change happened to the object. Allowed values are `INSERT`, `UPDATE` or `Delete`.   * `Invoice.Status` refers to field `Status` of the Zuora object `Invoice`.   * A variable with the `_old` suffix means it’s a previous value of the corresponding object field. The \"_old\" fields are only available on the base objects. | [optional] 
 **description** | **String** | The description of the filter rule. | [optional] 
 **event_type_name** | **String** | The value is `null`. | [optional] 
 **id** | **String** | The ID of the filter rule. If not specified or null, the notification definition is always qualified to process events of \"eventType\". | [optional] 
 **created_by** | **String** | The user who created the notification definition. | [optional] 
 **created_on** | **String** | The user who created the notification definition. | [optional] 
-**parameters** | [**{String: FilterRuleParameterDefinition}**](FilterRuleParameterDefinition.md) | The parameters of the filter rule and their name must match those in the filter rule. And all parameters must be defined in the event type payload. The name of parameters can't be duplicate. The following reserved keywords should not be used as a parameter name: `AttachmentList`, `RecipientList`, `RecipientType`, `Exceptions`, `OCP_OBJECT_TYPE`, `OCP_OBJECT_ID`, `OCP_TRIGGER_BY`  | [optional] 
+**parameters** | [**{String: FilterRuleParameterDefinition}**](FilterRuleParameterDefinition.md) | The parameters of the filter rule and their name must match those in the filter rule. And all parameters must be defined in the event type payload. The name of parameters can't be duplicate. The following reserved keywords should not be used as a parameter name: `AttachmentList`, `RecipientList`, `RecipientType`, `Exceptions`, `OCP_OBJECT_TYPE`, `OCP_OBJECT_ID`, `OCP_TRIGGER_BY` | [optional] 
 
 

package/docs/GetRampByRampNumberResponse.md

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

package/docs/GetRampMetricsByOrderNumberResponse.md

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

package/docs/GetRampMetricsByRampNumberResponse.md

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

package/docs/GetRampMetricsBySubscriptionKeyResponse.md

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

package/docs/GetRampsBySubscriptionKeyResponse.md

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

package/docs/GetRefundItemPartResponse.md

@@ -6,16 +6,16 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **amount** | **Number** | The amount of the refund part item.  | [optional] 
 **created_by_id** | **String** | The ID of the Zuora user who created the refund part item.  | [optional] 
-**created_date** | **String** | The date and time when the refund part item was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.  | [optional] 
+**created_date** | **String** | The date and time when the refund part item was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. | [optional] 
 **credit_memo_item_id** | **String** | The ID of the credit memo item associated with the refund part item.  | [optional] 
-**credit_tax_item_id** | **String** | The ID of the credit memo taxation item associated with the refund part item.  | [optional] 
+**credit_tax_item_id** | **String** | The ID of the credit memo taxation item associated with the refund part item. | [optional] 
 **id** | **String** | The ID of the refund part item.  | [optional] 
 **updated_by_id** | **String** | The ID of the Zuora user who last updated the refund part item.  | [optional] 
-**updated_date** | **String** | The date and time when the refund part item was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.  | [optional] 
+**updated_date** | **String** | The date and time when the refund part item was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. | [optional] 
 **organization_label** | **String** |  | [optional] 
 **process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
 **request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
 **reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
-**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 
 

package/docs/GetRefundItemPartsResponse.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **item_parts** | [**[RefundItemPart]**](RefundItemPart.md) | Container for refund part items.  | [optional] 
-**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent.  | [optional] 
+**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent. | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully. | [optional] 
 
 

package/docs/GetRefundPartResponse.md

@@ -6,16 +6,16 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **amount** | **Number** | The amount of the refund part.  | [optional] 
 **created_by_id** | **String** | The ID of the Zuora user who created the refund part.  | [optional] 
-**created_date** | **String** | The date and time when the refund part was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.  | [optional] 
+**created_date** | **String** | The date and time when the refund part was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. | [optional] 
 **credit_memo_id** | **String** | The ID of the credit memo associated with the refund part.  | [optional] 
 **id** | **String** | The ID of the refund part.  | [optional] 
 **payment_id** | **String** | The ID of the payment associated with the refund part.  | [optional] 
 **updated_by_id** | **String** | The ID of the Zuora user who last updated the refund part.  | [optional] 
-**updated_date** | **String** | The date and time when the refund part was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.  | [optional] 
+**updated_date** | **String** | The date and time when the refund part was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. | [optional] 
 **organization_label** | **String** |  | [optional] 
 **process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
 **request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
 **reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
-**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 
 

package/docs/GetRefundsResponse.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent.  | [optional] 
+**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent. | [optional] 
 **refunds** | [**[Refund]**](Refund.md) | Container for refunds.  | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully. | [optional] 
 

package/docs/GetScheduledEventResponse.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **active** | **Boolean** | Indicate whether the scheduled event is active or inactive | [optional] 
 **api_field** | **String** | The base field of the base object in the `apiObject` field, should be in date or timestamp format. The scheduled event notifications are triggered based on this date and the event parameters (before or after a specified number of days) from notification definitions. Should be specified in the pattern: ^[A-Z][\\\\w\\\\-]*$ | [optional] 
 **api_object** | **String** | The base object that the scheduled event is defined upon. The base object should contain a date or timestamp format field. Should be specified in the pattern: ^[A-Z][\\\\w\\\\-]*$ | [optional] 
-**condition** | **String** | The filter rule conditions, written in [JEXL](http://commons.apache.org/proper/commons-jexl/). The scheduled event is triggered only if the condition is evaluated as true. The rule might contain event context merge fields and data source merge fields. Data source merge fields must be from [the base object of the event or from the joined objects of the base object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects). Scheduled events with invalid merge fields will fail to evaluate, thus will not be triggered. For example, to trigger an invoice due date scheduled event to only invoices with an amount over 1000, you would define the following condition:  ```Invoice.Amount > 1000```  `Invoice.Amount` refers to the `Amount` field of the Zuora object `Invoice`.  | [optional] 
+**condition** | **String** | The filter rule conditions, written in [JEXL](http://commons.apache.org/proper/commons-jexl/). The scheduled event is triggered only if the condition is evaluated as true.  The rule might contain event context merge fields and data source merge fields. Data source merge fields must be from [the base object of the event or from the joined objects of the base object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects).  Scheduled events with invalid merge fields will fail to evaluate, thus will not be triggered. For example, to trigger an invoice due date scheduled event to only invoices with an amount over 1000, you would define the following condition:   ```Invoice.Amount > 1000```   `Invoice.Amount` refers to the `Amount` field of the Zuora object `Invoice`. | [optional] 
 **cron_expression** | **String** | The cron expression defines the time when scheduled event notifications will be sent. | [optional] 
 **description** | **String** | The description of the scheduled event. | [optional] 
 **display_name** | **String** | The display name of the scheduled event. | [optional] 

package/docs/GetSequenceSetResponse.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **credit_memo** | [**CreditMemoEntityPrefix**](CreditMemoEntityPrefix.md) |  | [optional] 
 **debit_memo** | [**DebitMemoEntityPrefix**](DebitMemoEntityPrefix.md) |  | [optional] 
-**id** | **String** | The unique ID of the sequence set. For example, 402892c74c9193cd014c96bbe7c101f9.  | [optional] 
+**id** | **String** | The unique ID of the sequence set. For example, 402892c74c9193cd014c96bbe7c101f9. | [optional] 
 **invoice** | [**InvoiceEntityPrefix**](InvoiceEntityPrefix.md) |  | [optional] 
 **name** | **String** | The name of the sequence set.  | [optional] 
 **payment** | [**PaymentEntityPrefix**](PaymentEntityPrefix.md) |  | [optional] 

package/docs/GetSequenceSetsResponse.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] 
 
 

package/docs/GetSubscriptionChangeLogResponse.md

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

package/docs/GetSubscriptionChangeLogsResponse.md

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

package/docs/GetSubscriptionRatePlan.md

@@ -7,15 +7,15 @@ Name | Type | Description | Notes
 **id** | **String** | Rate plan ID.  | [optional] 
 **subscription_rate_plan_number** | **String** |  | [optional] 
 **is_from_external_catalog** | **Boolean** |  | [optional] 
-**last_change_type** | **String** | The last amendment on the rate plan.    **Note:** If a subscription is created through an order, this field is only available if multiple orders are created on the subscription.   Possible Values:   * `Add`   * `Update`   * `Remove`  | [optional] 
+**last_change_type** | **String** | The last amendment on the rate plan.     **Note:** If a subscription is created through an order, this field is only available if multiple orders are created on the subscription.    Possible Values:   * `Add`   * `Update`   * `Remove` | [optional] 
 **product_id** | **String** |  | [optional] 
 **product_name** | **String** |  | [optional] 
 **product_sku** | **String** | The unique SKU for the product. | [optional] 
 **product_rate_plan_id** | **String** |  | [optional] 
 **product_rate_plan_number** | **String** |  | [optional] 
 **rate_plan_name** | **String** | Name of the rate plan. | [optional] 
-**subscription_product_features** | [**[SubscriptionProductFeature]**](SubscriptionProductFeature.md) | Container for one or more features.   Only available when the following settings are enabled:  * The Entitlements feature in your tenant.  * The Enable Feature Specification in Product and Subscriptions setting in Zuora Billing Settings | [optional] 
-**externally_managed_plan_id** | **String** | Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.  | [optional] 
+**subscription_product_features** | [**[SubscriptionProductFeature]**](SubscriptionProductFeature.md) | Container for one or more features.    Only available when the following settings are enabled:   * The Entitlements feature in your tenant.   * The Enable Feature Specification in Product and Subscriptions setting in Zuora Billing Settings | [optional] 
+**externally_managed_plan_id** | **String** | Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores. | [optional] 
 **contracted_mrr** | **Number** | Monthly recurring revenue of the subscription rate plan exclusive of all the discounts applicable.  | [optional] 
 **contracted_net_mrr** | **Number** | Monthly recurring revenue of the subscription rate plan inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts.  | [optional] 
 **as_of_day_gross_mrr** | **Number** | Monthly recurring revenue of the subscription rate plan exclusive of any discounts applicable as of specified day.  | [optional] 

package/docs/GetSubscriptionResponse.md

@@ -7,32 +7,32 @@ Name | Type | Description | Notes
 **process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
 **request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
 **reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
-**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] 
-**cpq_bundle_json_id__qt** | **String** | The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field.  | [optional] 
-**opportunity_close_date__qt** | **String** | The closing date of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.  | [optional] 
-**opportunity_name__qt** | **String** | The unique identifier of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.  | [optional] 
-**quote_business_type__qt** | **String** | The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal or Churn. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.  | [optional] 
-**quote_number__qt** | **String** | The unique identifier of the Quote. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.  | [optional] 
-**quote_type__qt** | **String** | The Quote type that represents the subscription lifecycle stage such as New, Amendment, Renew or Cancel. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.  | [optional] 
-**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**integration_status__ns** | **String** | Status of the subscription's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**project__ns** | **String** | The NetSuite project that the subscription was created from. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**sales_order__ns** | **String** | The NetSuite sales order than the subscription was created from. 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 subscription was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
+**cpq_bundle_json_id__qt** | **String** | The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field. | [optional] 
+**opportunity_close_date__qt** | **String** | The closing date of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. | [optional] 
+**opportunity_name__qt** | **String** | The unique identifier of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. | [optional] 
+**quote_business_type__qt** | **String** | The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal or Churn. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. | [optional] 
+**quote_number__qt** | **String** | The unique identifier of the Quote. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. | [optional] 
+**quote_type__qt** | **String** | The Quote type that represents the subscription lifecycle stage such as New, Amendment, Renew or Cancel. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. | [optional] 
+**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**integration_status__ns** | **String** | Status of the subscription's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**project__ns** | **String** | The NetSuite project that the subscription was created from. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**sales_order__ns** | **String** | The NetSuite sales order than the subscription was created from. 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 subscription was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
 **id** | **String** | Subscription ID.  | [optional] 
 **subscription_number** | **String** | Subscription number. | [optional] 
 **account_id** | **String** | The ID of the account associated with this subscription. | [optional] 
 **account_name** | **String** | The name of the account associated with this subscription. | [optional] 
 **account_number** | **String** | The number of the account associated with this subscription. | [optional] 
-**auto_renew** | **Boolean** | If `true`, the subscription automatically renews at the end of the term. Default is `false`.  | [optional] 
+**auto_renew** | **Boolean** | If `true`, the subscription automatically renews at the end of the term. Default is `false`. | [optional] 
 **bill_to_contact** | [**Contact**](Contact.md) |  | [optional] 
-**cancel_reason** | **String** | The reason for a subscription cancellation copied from the `changeReason` field of a Cancel Subscription order action.   This field contains valid value only if a subscription is cancelled through the Orders UI or API. Otherwise, the value for this field will always be `null`.  | [optional] 
+**cancel_reason** | **String** | The reason for a subscription cancellation copied from the `changeReason` field of a Cancel Subscription order action.    This field contains valid value only if a subscription is cancelled through the Orders UI or API. Otherwise, the value for this field will always be `null`. | [optional] 
 **communication_profile_id** | **String** | The ID of the communication profile associated with the subscription.  **Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature enabled.  | [optional] 
 **contract_effective_date** | **String** | Effective contract date for this subscription, as yyyy-mm-dd.  | [optional] 
 **contracted_mrr** | **Number** | Monthly recurring revenue of the subscription.  | [optional] 
 **current_term** | **Number** | The length of the period for the current subscription term.  | [optional] 
 **current_term_period_type** | [**TermPeriodType**](TermPeriodType.md) |  | [optional] 
-**customer_acceptance_date** | **String** | The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd.  | [optional] 
+**customer_acceptance_date** | **String** | The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd. | [optional] 
 **currency** | **String** | The currency of the subscription.  | [optional] 
 **create_time** | **String** | The date when the subscription was created, as yyyy-mm-dd HH:MM:SS.  | [optional] 
 **update_time** | **String** | The date when the subscription was last updated, as yyyy-mm-dd HH:MM:SS.  | [optional] 
@@ -43,31 +43,31 @@ Name | Type | Description | Notes
 **invoice_owner_account_id** | **String** |  | [optional] 
 **invoice_owner_account_name** | **String** |  | [optional] 
 **invoice_owner_account_number** | **String** |  | [optional] 
-**invoice_schedule_id** | **String** | The ID of the invoice schedule associated with the subscription.  If multiple invoice schedules are created for different terms of a subscription, this field stores the latest invoice schedule.  **Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Schedule\" target=\"_blank\">Billing Schedule</a> feature in the **Early Adopter** phase enabled.  | [optional] 
-**invoice_separately** | **String** | Separates a single subscription from other subscriptions and creates an invoice for the subscription.   If the value is `true`, the subscription is billed separately from other subscriptions. If the value is `false`, the subscription is included with other subscriptions in the account invoice.  | [optional] 
+**invoice_schedule_id** | **String** | The ID of the invoice schedule associated with the subscription.   If multiple invoice schedules are created for different terms of a subscription, this field stores the latest invoice schedule.   **Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Schedule\" target=\"_blank\">Billing Schedule</a> feature in the **Early Adopter** phase enabled. | [optional] 
+**invoice_separately** | **String** | Separates a single subscription from other subscriptions and creates an invoice for the subscription.    If the value is `true`, the subscription is billed separately from other subscriptions. If the value is `false`, the subscription is included with other subscriptions in the account invoice. | [optional] 
 **invoice_template_id** | **String** | The ID of the invoice template associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
 **invoice_template_name** | **String** | The name of the invoice template associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify the `invoiceTemplateId` field in the request or you select **Default Template from Account** for the `invoiceTemplateId` field during subscription creation, the value of the `invoiceTemplateName` field is automatically set to `null` in the response body.     | [optional] 
 **is_latest_version** | **Boolean** | If `true`, the current subscription object is the latest version. | [optional] 
-**last_booking_date** | **String** | The last booking date of the subscription object. This field is writable only when the subscription is newly created as a first version subscription. You can override the date value when creating a subscription through the Subscribe and Amend API or the subscription creation UI (non-Orders). Otherwise, the default value `today` is set per the user's timezone. The value of this field is as follows: * For a new subscription created by the [Subscribe and Amend APIs](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Migration_Guidance#Subscribe_and_Amend_APIs_to_Migrate), this field has the value of the subscription creation date. * For a subscription changed by an amendment, this field has the value of the amendment booking date. * For a subscription created or changed by an order, this field has the value of the order date.  | [optional] 
+**last_booking_date** | **String** | The last booking date of the subscription object. This field is writable only when the subscription is newly created as a first version subscription. You can override the date value when creating a subscription through the Subscribe and Amend API or the subscription creation UI (non-Orders). Otherwise, the default value `today` is set per the user's timezone. The value of this field is as follows:  * For a new subscription created by the [Subscribe and Amend APIs](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Migration_Guidance#Subscribe_and_Amend_APIs_to_Migrate), this field has the value of the subscription creation date.  * For a subscription changed by an amendment, this field has the value of the amendment booking date.  * For a subscription created or changed by an order, this field has the value of the order date.  | [optional] 
 **notes** | **String** | A string of up to 65,535 characters.  | [optional] 
-**order_number** | **String** | The order number of the order in which the changes on the subscription are made.   **Note:** This field is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). We will investigate your use cases and data before enabling this feature for you.  | [optional] 
-**payment_term** | **String** | The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
+**order_number** | **String** | The order number of the order in which the changes on the subscription are made.    **Note:** This field is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). We will investigate your use cases and data before enabling this feature for you. | [optional] 
+**payment_term** | **String** | The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.   **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. | [optional] 
 **rate_plans** | [**[SubscriptionRatePlan]**](SubscriptionRatePlan.md) | Container for rate plans.  | [optional] 
-**renewal_setting** | **String** | Specifies whether a termed subscription will remain `TERMED` or change to `EVERGREEN` when it is renewed.   Values are:  * `RENEW_WITH_SPECIFIC_TERM` (default) * `RENEW_TO_EVERGREEN`  | [optional] 
+**renewal_setting** | **String** | Specifies whether a termed subscription will remain `TERMED` or change to `EVERGREEN` when it is renewed.    Values are:   * `RENEW_WITH_SPECIFIC_TERM` (default)  * `RENEW_TO_EVERGREEN` | [optional] 
 **renewal_term** | **Number** | The length of the period for the subscription renewal term.  | [optional] 
 **renewal_term_period_type** | [**TermPeriodType**](TermPeriodType.md) |  | [optional] 
-**revision** | **String** | An auto-generated decimal value uniquely tagged with a subscription. The value always contains one decimal place, for example, the revision of a new subscription is 1.0. If a further version of the subscription is created, the revision value will be increased by 1. Also, the revision value is always incremental regardless of deletion of subscription versions.  | [optional] 
+**revision** | **String** | An auto-generated decimal value uniquely tagged with a subscription. The value always contains one decimal place, for example, the revision of a new subscription is 1.0. If a further version of the subscription is created, the revision value will be increased by 1. Also, the revision value is always incremental regardless of deletion of subscription versions. | [optional] 
 **sequence_set_id** | **String** | The ID of the sequence set associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
 **sequence_set_name** | **String** | The name of the sequence set associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify the `sequenceSetId` field in the request or you select **Default Template from Account** for the `sequenceSetId` field during subscription creation, the value of the `sequenceSetName` field is automatically set to `null` in the response body.  | [optional] 
-**service_activation_date** | **String** | The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd  | [optional] 
+**service_activation_date** | **String** | The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd | [optional] 
 **sold_to_contact** | [**Contact**](Contact.md) |  | [optional] 
 **ship_to_contact** | [**Contact**](Contact.md) |  | [optional] 
 **status** | [**SubscriptionStatus**](SubscriptionStatus.md) |  | [optional] 
 **status_history** | [**[SubscriptionStatusHistory]**](SubscriptionStatusHistory.md) | Container for status history.  | [optional] 
 **subscription_start_date** | **String** | Date the subscription becomes effective.  | [optional] 
-**subscription_end_date** | **String** | The date when the subscription term ends, where the subscription ends at midnight the day before. For example, if the `subscriptionEndDate` is 12/31/2016, the subscriptions ends at midnight (00:00:00 hours) on 12/30/2016. This date is the same as the term end date or the cancelation date, as appropriate.  | [optional] 
-**term_end_date** | **String** | Date the subscription term ends. If the subscription is evergreen, this is null or is the cancellation date (if one has been set).  | [optional] 
-**term_start_date** | **String** | Date the subscription term begins. If this is a renewal subscription, this date is different from the subscription start date.  | [optional] 
+**subscription_end_date** | **String** | The date when the subscription term ends, where the subscription ends at midnight the day before.  For example, if the `subscriptionEndDate` is 12/31/2016, the subscriptions ends at midnight (00:00:00 hours) on 12/30/2016.  This date is the same as the term end date or the cancelation date, as appropriate. | [optional] 
+**term_end_date** | **String** | Date the subscription term ends. If the subscription is evergreen, this is null or is the cancellation date (if one has been set). | [optional] 
+**term_start_date** | **String** | Date the subscription term begins. If this is a renewal subscription, this date is different from the subscription start date. | [optional] 
 **term_type** | **String** | Possible values are: `TERMED`, `EVERGREEN`.  | [optional] 
 **scheduled_cancel_date** | **String** |  | [optional] 
 **scheduled_suspend_date** | **String** |  | [optional] 

package/docs/GetSubscriptionsResponse.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent.  | [optional] 
+**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent. | [optional] 
 **subscriptions** | [**[GetSubscriptionResponse]**](GetSubscriptionResponse.md) | Array of subscriptions.  | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
 

package/docs/GetTaxationItemsOfCreditMemoItemResponse.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **data** | [**[GetCreditMemoTaxItemResponse]**](GetCreditMemoTaxItemResponse.md) | Container for the taxation items of the credit memo item.  | [optional] 
-**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent.  | [optional] 
+**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent. | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully. | [optional] 
 
 

package/docs/GetTaxationItemsOfDebitMemoItemResponse.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **data** | [**[GetDebitMemoTaxItemNew]**](GetDebitMemoTaxItemNew.md) | Container for the taxation items of the debit memo item.  | [optional] 
-**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent.  | [optional] 
+**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent. | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully. | [optional]