zuora-sdk-js 3.6.0 → 3.7.0

package/docs/UpdateSubscriptionChargeCustomFieldsOfASpecifiedVersion.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**charge_id** | **String** | Use either this field or the `chargeNumber` field to specify the charge for which you will be updating the custom fields. By using this field you actually specify a specific charge segment of a charge. See [Segmented rate plan charges](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/RatePlanCharge#Segmented_rate_plan_charges) for more information about charge segments.  | [optional] 
-**charge_number** | **String** | Use either this field or the `chargeId` field to specify the charge for which you will be updating the custom fields. By using this field you actually specify the last charge segment of a charge. See [Segmented rate plan charges](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/RatePlanCharge#Segmented_rate_plan_charges) for more information about charge segments.  | [optional] 
+**charge_id** | **String** | Use either this field or the `chargeNumber` field to specify the charge for which you will be updating the custom fields. By using this field you actually specify a specific charge segment of a charge. See [Segmented rate plan charges](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/RatePlanCharge#Segmented_rate_plan_charges) for more information about charge segments. | [optional] 
+**charge_number** | **String** | Use either this field or the `chargeId` field to specify the charge for which you will be updating the custom fields. By using this field you actually specify the last charge segment of a charge. See [Segmented rate plan charges](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/RatePlanCharge#Segmented_rate_plan_charges) for more information about charge segments. | [optional] 
 **custom_fields** | **{String: Object}** | Container for custom fields of a Rate Plan Charge object.  | [optional] 
 
 

package/docs/UpdateSubscriptionRatePlanCustomFields.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **charges** | [**[UpdateSubscriptionChargeCustomFields]**](UpdateSubscriptionChargeCustomFields.md) |  | [optional] 
-**custom_fields** | **{String: Object}** | Container for custom fields of the Rate Plan object. The custom fields of the Rate Plan object are used when rate plans are subscribed.  | [optional] 
+**custom_fields** | **{String: Object}** | Container for custom fields of the Rate Plan object. The custom fields of the Rate Plan object are used when rate plans are subscribed. | [optional] 
 **rate_plan_id** | **String** | The rate plan id in any version of the subscription. This will be linked to the only one rate plan in the current version. | [optional] 
 
 

package/docs/UpdateSubscriptionRequest.md

@@ -4,46 +4,46 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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] 
+**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] 
 **add** | [**[AddSubscriptionRatePlan]**](AddSubscriptionRatePlan.md) | Container for adding one or more rate plans.  | [optional] 
-**application_order** | **[String]** | The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.  **Note:**   - This field is valid only if the `applyCredit` field is set to `true`.   - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.   - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices.  | [optional] 
-**apply_credit** | **Boolean** | Whether to automatically apply credit memos or unapplied payments, or both to an invoice.  If the value is `true`, the credit memo or unapplied payment, or both will be automatically applied to the invoice. If no value is specified or the value is `false`, no action is taken.  **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.  | [optional] 
-**apply_credit_balance** | **Boolean** | Whether to automatically apply a credit balance to an invoice.  If the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken.   To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.  Prerequisite: `invoice` must be `true`.   **Note:**    - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.   - This field is deprecated if you have the Invoice Settlement feature enabled.  | [optional] 
-**auto_renew** | **Boolean** | If `true`, this subscription automatically renews at the end of the subscription term. Default is `false`.  | [optional] 
-**booking_date** | **String** | The booking date that you want to set for the contract when you change the `termType` field of the subscription and as a result get a new version of subscription created. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the `yyyy-mm-dd` format. The default value is the current date when you make the API call.   | [optional] 
-**change** | [**[ChangeSubscriptionRatePlan]**](ChangeSubscriptionRatePlan.md) | Use this field to change one or more rate plans - to replace the existing rate plans in a subscription with other rate plans.  **Note**: Changing rate plans is currently not supported for Billing - Revenue Integration. When Billing - Revenue Integration is enabled, changing rate plans will no longer be applicable in Zuora Billing.  | [optional] 
-**collect** | **Boolean** | Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account.  If the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken.  Prerequisite: The `invoice` or `runBilling` field must be `true`.   **Note**: This field is only available if you set the `zuora-version` request header to `196.0` or later.  | [optional] 
+**application_order** | **[String]** | The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.   **Note:**   - This field is valid only if the `applyCredit` field is set to `true`.   - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.   - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices. | [optional] 
+**apply_credit** | **Boolean** | Whether to automatically apply credit memos or unapplied payments, or both to an invoice.   If the value is `true`, the credit memo or unapplied payment, or both will be automatically applied to the invoice. If no value is specified or the value is `false`, no action is taken.   **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. | [optional] 
+**apply_credit_balance** | **Boolean** | Whether to automatically apply a credit balance to an invoice.   If the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken.    To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.   Prerequisite: `invoice` must be `true`.    **Note:**    - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.   - This field is deprecated if you have the Invoice Settlement feature enabled. | [optional] 
+**auto_renew** | **Boolean** | If `true`, this subscription automatically renews at the end of the subscription term. Default is `false`. | [optional] 
+**booking_date** | **String** | The booking date that you want to set for the contract when you change the `termType` field of the subscription and as a result get a new version of subscription created. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the `yyyy-mm-dd` format. The default value is the current date when you make the API call.  | [optional] 
+**change** | [**[ChangeSubscriptionRatePlan]**](ChangeSubscriptionRatePlan.md) | Use this field to change one or more rate plans - to replace the existing rate plans in a subscription with other rate plans.   **Note**: Changing rate plans is currently not supported for Billing - Revenue Integration. When Billing - Revenue Integration is enabled, changing rate plans will no longer be applicable in Zuora Billing. | [optional] 
+**collect** | **Boolean** | Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account.   If the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken.   Prerequisite: The `invoice` or `runBilling` field must be `true`.    **Note**: This field is only available if you set the `zuora-version` request header to `196.0` or later. | [optional] 
 **credit_memo_reason_code** | **String** | A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code. | [optional] 
-**current_term** | **Number** | The length of the period for the current subscription term. If `termType` is `TERMED`, this field is required and must be greater than `0`. If `termType` is `EVERGREEN`, this value is ignored.  | [optional] 
-**current_term_period_type** | **String** | The period type for the current subscription term.  This field is used with the `CurrentTerm` field to specify the current subscription term.  Values are:  * `Month` (default) * `Year` * `Day` * `Week`  | [optional] 
-**document_date** | **String** | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.  - If this field is specified, the specified date is used as the billing document date.  - If this field is not specified, the date specified in the `targetDate` is used as the billing document date.  | [optional] 
-**externally_managed_by** | **String** | An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.  | [optional] 
-**include_existing_draft_doc_items** | **Boolean** | Specifies whether to include draft invoice items in subscription previews. Values are:  * `true` (default). Includes draft invoice items in the preview result. * `false`. Excludes draft invoice items in the preview result.  **Note:** This field is in Zuora REST API version control. Supported minor versions are 207.0 or later. To use this field in the method, you must set the **zuora-version** parameter to the minor version number in the request header. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information.  | [optional] 
-**include_existing_draft_invoice_items** | **Boolean** | Specifies whether to include draft invoice items in subscription previews. Values are:  * `true` (default). Includes draft invoice items in the preview result. * `false`. Excludes draft invoice items in the preview result.  **Note:** This field is in Zuora REST API version control. Supported minor versions are 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information.  | [optional] 
+**current_term** | **Number** | The length of the period for the current subscription term. If `termType` is `TERMED`, this field is required and must be greater than `0`. If `termType` is `EVERGREEN`, this value is ignored. | [optional] 
+**current_term_period_type** | **String** | The period type for the current subscription term.   This field is used with the `CurrentTerm` field to specify the current subscription term.   Values are:   * `Month` (default)  * `Year`  * `Day`  * `Week` | [optional] 
+**document_date** | **String** | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.   - If this field is specified, the specified date is used as the billing document date.   - If this field is not specified, the date specified in the `targetDate` is used as the billing document date. | [optional] 
+**externally_managed_by** | **String** | An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores. | [optional] 
+**include_existing_draft_doc_items** | **Boolean** | Specifies whether to include draft invoice items in subscription previews.  Values are:   * `true` (default). Includes draft invoice items in the preview result.  * `false`. Excludes draft invoice items in the preview result.   **Note:** This field is in Zuora REST API version control. Supported minor versions are 207.0 or later. To use this field in the method, you must set the **zuora-version** parameter to the minor version number in the request header. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information. | [optional] 
+**include_existing_draft_invoice_items** | **Boolean** | Specifies whether to include draft invoice items in subscription previews.  Values are:   * `true` (default). Includes draft invoice items in the preview result.  * `false`. Excludes draft invoice items in the preview result.   **Note:** This field is in Zuora REST API version control. Supported minor versions are 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information. | [optional] 
 **invoice** | **Boolean** | **Note:** This field has been replaced by the `runBilling` field. The `invoice` field is only available for backward compatibility.   Creates an invoice for a subscription. The invoice generated in this operation is only for this subscription, not for the entire customer account.   If the value is `true`, an invoice is created. If the value is `false`, no action is taken. The default value is `false`.    This field is in Zuora REST API version control. Supported minor versions are `196.0` and `207.0`. To use this field in the method, you must set the zuora-version parameter to the minor version number in the request header.  | [optional] 
-**invoice_collect** | **Boolean** | **Note:** This field has been replaced by the `invoice` field and the `collect` field. `invoiceCollect` is available only for backward compatibility.   If `true`, an invoice is generated and payment collected automatically during the subscription process. If `false`, no invoicing or payment takes place.  The invoice generated in this operation is only for this subscription, not for the entire customer account.  **Note**: This field is only available if you set the `zuora-version` request header to `186.0`, `187.0`, `188.0`, or `189.0`.  | [optional] 
-**invoice_separately** | **Boolean** | Separates a single subscription from other subscriptions and invoices the charge independently.   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.  The default value is `false`. Prerequisite: The default subscription setting Enable Subscriptions to be Invoiced Separately must be set to Yes.  | [optional] 
+**invoice_collect** | **Boolean** | **Note:** This field has been replaced by the `invoice` field  and the `collect` field. `invoiceCollect` is available only for backward  compatibility.    If `true`, an invoice is generated and payment collected automatically during  the subscription process. If `false`, no invoicing or payment  takes place.  The invoice generated in this operation is only for this subscription,  not for the entire customer account.   **Note**: This field is only available if you set the `zuora-version` request header to `186.0`, `187.0`, `188.0`, or `189.0`. | [optional] 
+**invoice_separately** | **Boolean** | Separates a single subscription from other subscriptions and invoices the charge independently.    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.   The default value is `false`.  Prerequisite: The default subscription setting Enable Subscriptions to be Invoiced Separately must be set to Yes. | [optional] 
 **invoice_target_date** | **String** | **Note:** This field has been replaced by the `targetDate` field. The `invoiceTargetDate` field is only available for backward compatibility.   Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.   This field is in Zuora REST API version control. Supported minor versions are `207.0` and earlier.  | [optional] 
 **notes** | **String** | String of up to 500 characters.  | [optional] 
-**preview** | **Boolean** | If `true` the update is made in preview mode. The default setting is `false`.  | [optional] 
-**preview_type** | **String** | The type of preview you will receive.   This field is in Zuora REST API version control. The supported values of this field depend on the REST API minor version you specified in the request header.   * If you do not specify the REST API minor version or specify the minor version number to one of following values in the request header:    * 186.0   * 187.0   * 188.0   * 189.0   * 196.0   * 206.0    The following values are supported in the **previewType** field:    * InvoiceItem   * ChargeMetrics   * InvoiceItemChargeMetrics    The default value is InvoiceItem.  * If you specify the REST API minor version to 207.0 or later in the request header, the following values are supported in the **previewType** field:    - LegalDoc   - ChargeMetrics   - LegalDocChargeMetrics    The default value is LegalDoc.  See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information.  | [optional] 
+**preview** | **Boolean** | If `true` the update is made in preview mode. The default setting is `false`. | [optional] 
+**preview_type** | **String** | The type of preview you will receive.    This field is in Zuora REST API version control. The supported values of this field depend on the REST API minor version you specified in the request header.    * If you do not specify the REST API minor version or specify the minor version number to one of following values in the request header:    * 186.0   * 187.0   * 188.0   * 189.0   * 196.0   * 206.0    The following values are supported in the **previewType** field:    * InvoiceItem   * ChargeMetrics   * InvoiceItemChargeMetrics    The default value is InvoiceItem.  * If you specify the REST API minor version to 207.0 or later in the request header, the following values are supported in the **previewType** field:    - LegalDoc   - ChargeMetrics   - LegalDocChargeMetrics    The default value is LegalDoc.  See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information. | [optional] 
 **remove** | [**[RemoveSubscriptionRatePlan]**](RemoveSubscriptionRatePlan.md) | Container for removing one or more 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_term** | **Number** | The length of the period for the subscription renewal term. Default is `0`.  | [optional] 
-**renewal_term_period_type** | **String** |  The period type for the subscription renewal term.  This field is used with the `renewalTerm` field to specify the subscription renewal term.  Values are:  * `Month` (default) * `Year` * `Day` * `Week`  | [optional] 
-**run_billing** | **Boolean** | Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos).     The billing documents generated in this operation is only for this subscription, not for the entire customer account.   Possible values:  - `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created.   - `false`: No invoice is created.   **Note:** This field is in Zuora REST API version control. Supported minor versions are `211.0` or later. To use this field in the method, you must set the `zuora-version` parameter to the minor version number in the request header.  | [optional] 
-**target_date** | **String** | Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date.   **Note:** The credit memo is only available if you have the Invoice Settlement feature enabled.   This field is in Zuora REST API version control. Supported minor versions are `211.0` and later. To use this field in the method, you must set the  `zuora-version` parameter to the minor version number in the request header.  | [optional] 
-**term_start_date** | **String** | Date the subscription term begins, as yyyy-mm-dd. If this is a renewal subscription, this date is different from the subscription start date.   | [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. Default is `0`. | [optional] 
+**renewal_term_period_type** | **String** |  The period type for the subscription renewal term.   This field is used with the `renewalTerm` field to specify the subscription renewal term.   Values are:   * `Month` (default)  * `Year`  * `Day`  * `Week` | [optional] 
+**run_billing** | **Boolean** | Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos).      The billing documents generated  in this operation is only for this subscription, not for the entire  customer account.    Possible values:   - `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created.    - `false`: No invoice is created.    **Note:** This field is in Zuora REST API version control. Supported  minor versions are `211.0` or later. To use this field in the method,  you must set the `zuora-version` parameter to the minor version number  in the request header. | [optional] 
+**target_date** | **String** | Date through which to calculate charges if an invoice or a credit memo is generated, as  yyyy-mm-dd. Default is current date.    **Note:** The credit memo is only available if you have the Invoice Settlement feature enabled.    This field is in Zuora REST API version control. Supported minor  versions are `211.0` and later. To use this field in the method, you  must set the  `zuora-version` parameter to the minor version number in  the request header. | [optional] 
+**term_start_date** | **String** | Date the subscription term begins, as yyyy-mm-dd. If this is a renewal subscription, this date is different from the subscription start date.  | [optional] 
 **term_type** | **String** | Possible values are: `TERMED`, `EVERGREEN`.  | [optional] 
 **update** | [**[UpdateSubscriptionRatePlan]**](UpdateSubscriptionRatePlan.md) | Container for updating one or more rate plans.  | [optional] 
 

package/docs/UpdateSubscriptionResponse.md

@@ -8,19 +8,19 @@ Name | Type | Description | Notes
 **amount_without_tax** | **Number** | Invoice amount minus tax. Preview mode only. This field is in Zuora REST API version control. Supported minor versions are `206.0` and earlier. It is moved to this **invoice** container after 206.0  | [optional] 
 **charge_metrics** | [**ChargeMetrics**](ChargeMetrics.md) |  | [optional] 
 **credit_memo** | [**SubscriptionCreditMemo**](SubscriptionCreditMemo.md) |  | [optional] 
-**credit_memo_id** | **String** | The credit memo ID, if a credit memo is generated during the subscription process.  **Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later in the request header, and you have  [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.  | [optional] 
+**credit_memo_id** | **String** | The credit memo ID, if a credit memo is generated during the subscription process.   **Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later in the request header, and you have  [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. | [optional] 
 **invoice** | [**PreviewSubscriptionInvoice**](PreviewSubscriptionInvoice.md) |  | [optional] 
 **invoice_id** | **String** | Invoice ID, if an invoice is generated during the update.  | [optional] 
 **invoice_items** | [**[PreviewSubscriptionInvoiceItem]**](PreviewSubscriptionInvoiceItem.md) | This field is only available REST API max version 206.0. Container for invoice items.  | [optional] 
-**invoice_target_date** | **String** | Date through which charges are calculated on the invoice, as yyyy-mm-dd. Preview mode only.  **Note:** This field is only available if you do not specify the Zuora REST API minor version or specify the minor version to 186.0, 187.0, 188.0, 189.0, and 196.0. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information.  | [optional] 
+**invoice_target_date** | **String** | Date through which charges are calculated on the invoice, as yyyy-mm-dd. Preview mode only.   **Note:** This field is only available if you do not specify the Zuora REST API minor version or specify the minor version to 186.0, 187.0, 188.0, 189.0, and 196.0. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information. | [optional] 
 **paid_amount** | **Number** | Payment amount, if a payment is collected  | [optional] 
 **payment_id** | **String** | Payment ID, if a payment is collected.  | [optional] 
 **subscription_id** | **String** | The ID of the resulting new subscription.  | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
-**target_date** | **String** | Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.  **Note:** This field is only available if you set the Zuora REST API minor version to 207.0 or later in the request header. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information.  | [optional] 
+**target_date** | **String** | Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.   **Note:** This field is only available if you set the Zuora REST API minor version to 207.0 or later in the request header. See [Zuora REST API Versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions) for more information. | [optional] 
 **tax_amount** | **Number** | Tax amount on the invoice. This field is in Zuora REST API version control. Supported minor versions are `206.0` and earlier. It is moved to this **invoice** container after 206.0  | [optional] 
-**total_delta_mrr** | **Number** | Change in the subscription monthly recurring revenue as a result of the update.  | [optional] 
-**total_delta_tcv** | **Number** | Change in the total contracted value of the subscription as a result of the update.  | [optional] 
+**total_delta_mrr** | **Number** | Change in the subscription monthly recurring revenue as a result of the update. | [optional] 
+**total_delta_tcv** | **Number** | Change in the total contracted value of the subscription as a result of the update. | [optional] 
 **order_numbers** | **[String]** | The order numbers. It is available for Orders Tenants.  | [optional] 
 
 

package/docs/UpdaterPaymentMethodRequestAccountHolderInfo.md

@@ -4,10 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**address_line1** | **String** | The first line of the address for the account holder.  This field is required for SEPA Direct Debit payment methods on Stripe v2 for [certain countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method).  | [optional] 
+**address_line1** | **String** | The first line of the address for the account holder.   This field is required for SEPA Direct Debit payment methods on Stripe v2 for [certain countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method). | [optional] 
 **address_line2** | **String** | The second line of the address for the account holder.   | [optional] 
 **city** | **String** | The city where the account holder stays.  | [optional] 
-**country** | **String** | The country where the account holder stays.  This field is required for SEPA payment methods on Stripe v2 for [certain countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method).  | [optional] 
+**country** | **String** | The country where the account holder stays.   This field is required for SEPA payment methods on Stripe v2 for [certain countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method). | [optional] 
 **email** | **String** | The email address of the account holder.  | [optional] 
 **phone** | **String** | The phone number of the account holder.  | [optional] 
 **state** | **String** | The state where the account holder stays.  | [optional] 

package/docs/UploadUsageFileResponse.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**check_import_status** | **String** | The path for checking the status of the import.  The possible status values at this path are `Pending`, `Processing`, `Completed`, `Canceled`, and `Failed`. Only `Completed` indicates that the file contents were imported successfully.  | [optional] 
+**check_import_status** | **String** | The path for checking the status of the import.   The possible status values at this path are `Pending`, `Processing`, `Completed`, `Canceled`, and `Failed`. Only `Completed` indicates that the file contents were imported successfully. | [optional] 
 **size** | **Number** | The size of the uploaded file in bytes.  | [optional] 
 **success** | **Boolean** | Indicates whether the call succeeded.  | [optional] 
 

package/docs/UsageApi.md

@@ -410,7 +410,7 @@ Name | Type | Description  | Notes
 
 Upload a usage file
 
-This REST API reference describes how to post or import usage data for one or more accounts in the CSV format. There are no path or query parameters. The data is uploaded using the HTTP multipart/form-data Post method and applied to the user's tenant.   ### How this REST API Call Works The content of the uploaded usage file must follow the format used by the UI import tool. It must be a comma-separated (CSV) file with a corresponding .csv extension. The length of the file name must not exceed 50 characters. The file size must not exceed 4MB. See [Downloading the Usage Template](https://knowledgecenter.zuora.com/CB_Billing/J_Billing_Operations/Usage/C_Import_Usage_Data#Downloading_the_Usage_Template) to learn about how to download the usage file template.  At the completion of the upload, before the file contents are actually being processed, the API returns a response containing the byte count of the received file and a URL for checking the status of the import process.  Of the five possible results displayed at that URL (Pending, Processing, Completed, Canceled, and Failed) only a Completed status indicates that the import was successful.  The operation is atomic; if any record fails, the file is rejected. In that case, the entire import is rolled back and all stored data is returned to its original state.  To view the actual import status, enter the resulting status URL from the checkImportStatus response using a tool such as PostMAN. This additional step provides more information about why the import has failed.  To manage the information after a successful upload, use the web-based UI.  ### Usage File Format The usage file uses the following headings:   | Heading         | Description   | Required | |-----------------|--------|----------| | ACCOUNT_ID      | Enter the account number, e.g., the default account number, such as A00000001, or your custom account number. Although this field is labeled as Account_Id, it is not the actual Account ID nor Account Name.  | Yes      | | UOM             | Enter the unit of measure. This must match the UOM for the usage. | Yes      | | QTY             | Enter the quantity.  | Yes      | | STARTDATE       | Enter the start date of the usage. This date determines the invoice item service period the associated usage is billed to. Date format is based on locale of the current user. Default date format: `MM/DD/YYYY`. | Yes | | ENDDATE         | Enter the end date of the usage. This is not used in calculations for usage billing and is optional. Date format is based on locale of the current user. Default date format: `MM/DD/YYYY`. <p>**Note:** The value of this column is optional, but the column header is required.</p> | No | | SUBSCRIPTION_ID | Enter the subscription number or subscription name. If you created the subscription in the Zuora application, Zuora created a number automatically in a format similar to A-S00000001. If you do not provide a value for this field, the associated usage will be added to all subscriptions for the specified Account that use this Unit Of Measure. If your Accounts can have multiple subscriptions and you do not want double or triple counting of usage, you must specify the Subscription or Charge ID in each usage record.  <p>**Note:** The value of this column is optional, but the column header is required.</p>  | No   | | CHARGE_ID       | Enter the charge number (not the charge name). You can see the charge ID, e.g., C-00000001, when you add your rate plan to your subscription and view your individual charges. If your Accounts can have multiple subscriptions and you do not want double or triple counting of usage, you must specify the specific Subscription or Charge ID in each usage record. This field is related to the Charge Number on the subscription rate plan.  <p>**Note:** The value of this column is optional, but the column header is required.</p>  | No      | | DESCRIPTION     | Enter a description for the charge. | No       | | UNIQUE_KEY      | Enter a specific identifier for this usage record. **Note**: This Heading is supported by the following <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing\">Advanced Consumption Billing</a> features: <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_with_Drawdown\">Prepaid with Drawdown</a>, and <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Unbilled_Usage\">Unbilled Usage</a>. See <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_with_Drawdown/L_Prepaid_balance_transactions#Upload_usage_record_with_unique_key\">Upload usage record with unique key</a> for more information.  | No      | 
+This REST API reference describes how to post or import usage data for one or more accounts in the CSV format. There are no path or query parameters. The data is uploaded using the HTTP multipart/form-data Post method and applied to the user's tenant.   ### How this REST API Call Works The content of the uploaded usage file must follow the format used by the UI import tool. It must be a comma-separated (CSV) file with a corresponding .csv extension. The length of the file name must not exceed 50 characters. The file size must not exceed 4MB. See [Downloading the Usage Template](https://knowledgecenter.zuora.com/CB_Billing/J_Billing_Operations/Usage/C_Import_Usage_Data#Downloading_the_Usage_Template) to learn about how to download the usage file template.  At the completion of the upload, before the file contents are actually being processed, the API returns a response containing the byte count of the received file and a URL for checking the status of the import process.  Of the five possible results displayed at that URL (Pending, Processing, Completed, Canceled, and Failed) only a Completed status indicates that the import was successful.  The operation is atomic; if any record fails, the file is rejected. In that case, the entire import is rolled back and all stored data is returned to its original state. nTo view the actual import status, enter the resulting status URL from the checkImportStatus response using a tool such as PostMAN. This additional step provides more information about why the import has failed.  To manage the information after a successful upload, use the web-based UI.  ### Usage File Format The usage file uses the following headings:   | Heading         | Description   | Required | |-----------------|--------|----------| | ACCOUNT_ID      | Enter the account number, e.g., the default account number, such as A00000001, or your custom account number. Although this field is labeled as Account_Id, it is not the actual Account ID nor Account Name.  | Yes      | | UOM             | Enter the unit of measure. This must match the UOM for the usage. | Yes      | | QTY             | Enter the quantity.  | Yes      | | STARTDATE       | Enter the start date of the usage. This date determines the invoice item service period the associated usage is billed to. Date format is based on locale of the current user. Default date format: `MM/DD/YYYY`. | Yes | | ENDDATE         | Enter the end date of the usage. This is not used in calculations for usage billing and is optional. Date format is based on locale of the current user. Default date format: `MM/DD/YYYY`. <p>**Note:** The value of this column is optional, but the column header is required.</p> | No | | SUBSCRIPTION_ID | Enter the subscription number or subscription name. If you created the subscription in the Zuora application, Zuora created a number automatically in a format similar to A-S00000001. If you do not provide a value for this field, the associated usage will be added to all subscriptions for the specified Account that use this Unit Of Measure. If your Accounts can have multiple subscriptions and you do not want double or triple counting of usage, you must specify the Subscription or Charge ID in each usage record.  <p>**Note:** The value of this column is optional, but the column header is required.</p>  | No   | | CHARGE_ID       | Enter the charge number (not the charge name). You can see the charge ID, e.g., C-00000001, when you add your rate plan to your subscription and view your individual charges. If your Accounts can have multiple subscriptions and you do not want double or triple counting of usage, you must specify the specific Subscription or Charge ID in each usage record. This field is related to the Charge Number on the subscription rate plan.  <p>**Note:** The value of this column is optional, but the column header is required.</p>  | No      | | DESCRIPTION     | Enter a description for the charge. | No       | | UNIQUE_KEY      | Enter a specific identifier for this usage record. **Note**: This Heading is supported by the following <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing\">Advanced Consumption Billing</a> features: <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_with_Drawdown\">Prepaid with Drawdown</a>, and <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Unbilled_Usage\">Unbilled Usage</a>. See <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_with_Drawdown/L_Prepaid_balance_transactions#Upload_usage_record_with_unique_key\">Upload usage record with unique key</a> for more information.  | No      | 
 
 ### Example
 

package/docs/UsageItem.md

@@ -11,13 +11,13 @@ Name | Type | Description | Notes
 **product_rate_plan_charge_number** | **String** | Product rate plan charge number. **Note**: This field is only available if you have the [Dynamic Usage Charge] enabled.  | [optional] 
 **subscription_number** | **String** | Number of the subscription covering this usage.  | [optional] 
 **charge_number** | **String** | Number of the rate-plan charge that pays for this usage.  | [optional] 
-**start_date_time** | **String** | Start date of the time period in which usage is tracked. Zuora uses this field value to determine the usage date.  | [optional] 
+**start_date_time** | **String** | Start date of the time period in which usage is tracked. Zuora uses this field value to determine the usage date. | [optional] 
 **unit_of_measure** | **String** | Unit used to measure consumption.  | [optional] 
 **quantity** | **Number** | Number of units used.  | [optional] 
 **source_name** | **String** | Source of the usage data. Possible values are: `Import`, `API`.  | [optional] 
-**file_name** | **String** | The name of the import file when the usage record is imported from the file.  | [optional] 
+**file_name** | **String** | The name of the import file when the usage record is imported from the file. | [optional] 
 **status** | **String** | Possible values are: `Importing`, `Pending`, `Processed`.  | [optional] 
 **submission_date_time** | **String** | Date when usage was submitted.  | [optional] 
-**unique_key** | **String** | a customer-defined specific identifier of a usage record.  **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) or  [Unbilled Usage](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage) feature enabled. See [Upload usage record with unique key](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Prepaid_balance_transactions#Upload_usage_record_with_unique_key) for more information.  | [optional] 
+**unique_key** | **String** | a customer-defined specific identifier of a usage record.   **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) or  [Unbilled Usage](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage) feature enabled. See [Upload usage record with unique key](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Prepaid_balance_transactions#Upload_usage_record_with_unique_key) for more information. | [optional] 
 
 

package/docs/UsageOveragePricingOverride.md

@@ -7,10 +7,10 @@ Name | Type | Description | Notes
 **price_change_option** | [**PriceChangeOption**](PriceChangeOption.md) |  | [optional] 
 **price_increase_percentage** | **Number** | Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`.  | [optional] 
 **included_units** | **Number** | Number of free units that may be consumed.  | [optional] 
-**number_of_periods** | **Number** | Number of periods that Zuora considers when calculating overage charges with overage smoothing.  | [optional] 
+**number_of_periods** | **Number** | Number of periods that Zuora considers when calculating overage charges with overage smoothing. | [optional] 
 **overage_price** | **Number** | Price per overage unit consumed.  | [optional] 
-**overage_unused_units_credit_option** | **String** | Specifies whether to credit the customer for unused units.  If the value of this field is `CreditBySpecificRate`, use the `unusedUnitsCreditRates` field to specify the rate at which to credit the customer for unused units.  | [optional] 
-**unused_units_credit_rates** | **Number** | Per-unit rate at which to credit the customer for unused units. Only applicable if the value of the `overageUnusedUnitsCreditOption` field is `CreditBySpecificRate`.  | [optional] 
+**overage_unused_units_credit_option** | **String** | Specifies whether to credit the customer for unused units.   If the value of this field is `CreditBySpecificRate`, use the `unusedUnitsCreditRates` field to specify the rate at which to credit the customer for unused units. | [optional] 
+**unused_units_credit_rates** | **Number** | Per-unit rate at which to credit the customer for unused units. Only applicable if the value of the `overageUnusedUnitsCreditOption` field is `CreditBySpecificRate`. | [optional] 
 
 
 

package/docs/UsageOveragePricingUpdate.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **price_change_option** | [**PriceChangeOption**](PriceChangeOption.md) |  | [optional] 
 **price_increase_percentage** | **Number** | Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`.  | [optional] 
-**included_units** | **Number** | A certain quantity of units for free in the overage charge model. It cannot be negative. It must be 0 and above. Decimals are allowed.  | [optional] 
+**included_units** | **Number** | A certain quantity of units for free in the overage charge model. It cannot be negative. It must be 0 and above. Decimals are allowed. | [optional] 
 **overage_price** | **Number** |  | [optional] 
 
 

package/docs/UsagePerUnitPricingOverride.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **list_price** | **Number** | Per-unit price of the charge.  | [optional] 
 **original_list_price** | **Number** | The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.  **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.  | [optional] 
 **uom** | **String** | Unit of measure of the standalone charge.  **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.  | [optional] 
-**rating_group** | **String** | Specifies how Zuora groups usage records when rating usage. See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group) for more information.   * ByBillingPeriod (default): The rating is based on all the usages in a billing period.   * ByUsageStartDate: The rating is based on all the usages on the same usage start date.    * ByUsageRecord: The rating is based on each usage record.   * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.  | [optional] 
+**rating_group** | **String** | Specifies how Zuora groups usage records when rating usage. See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group) for more information.   * ByBillingPeriod (default): The rating is based on all the usages in a billing period.   * ByUsageStartDate: The rating is based on all the usages on the same usage start date.    * ByUsageRecord: The rating is based on each usage record.   * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file. | [optional] 
 
 
 

package/docs/UsageTieredPricingOverride.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **price_change_option** | [**PriceChangeOption**](PriceChangeOption.md) |  | [optional] 
 **price_increase_percentage** | **Number** | Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`.  | [optional] 
-**rating_group** | **String** | Specifies how Zuora groups usage records when rating usage. See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group) for more information.   * ByBillingPeriod (default): The rating is based on all the usages in a billing period.   * ByUsageStartDate: The rating is based on all the usages on the same usage start date.    * ByUsageRecord: The rating is based on each usage record.   * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.  | [optional] 
+**rating_group** | **String** | Specifies how Zuora groups usage records when rating usage. See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group) for more information.   * ByBillingPeriod (default): The rating is based on all the usages in a billing period.   * ByUsageStartDate: The rating is based on all the usages on the same usage start date.    * ByUsageRecord: The rating is based on each usage record.   * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file. | [optional] 
 **tiers** | [**[ChargeTier]**](ChargeTier.md) | List of cumulative pricing tiers in the charge.  | [optional] 
 **uom** | **String** | Unit of measure of the standalone charge.  **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.  | [optional] 
 

package/docs/UsageTieredWithOveragePricingOverride.md

@@ -6,11 +6,11 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **price_change_option** | [**PriceChangeOption**](PriceChangeOption.md) |  | [optional] 
 **price_increase_percentage** | **Number** | Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`.  | [optional] 
-**number_of_periods** | **Number** | Number of periods that Zuora considers when calculating overage charges with overage smoothing.  | [optional] 
+**number_of_periods** | **Number** | Number of periods that Zuora considers when calculating overage charges with overage smoothing. | [optional] 
 **overage_price** | **Number** | Price per overage unit consumed.  | [optional] 
-**overage_unused_units_credit_option** | **String** | Specifies whether to credit the customer for unused units.  If the value of this field is `CreditBySpecificRate`, use the `unusedUnitsCreditRates` field to specify the rate at which to credit the customer for unused units.  | [optional] 
+**overage_unused_units_credit_option** | **String** | Specifies whether to credit the customer for unused units.   If the value of this field is `CreditBySpecificRate`, use the `unusedUnitsCreditRates` field to specify the rate at which to credit the customer for unused units. | [optional] 
 **tiers** | [**[ChargeTier]**](ChargeTier.md) | List of cumulative pricing tiers in the charge.  | [optional] 
-**unused_units_credit_rates** | **Number** | Per-unit rate at which to credit the customer for unused units. Only applicable if the value of the `overageUnusedUnitsCreditOption` field is `CreditBySpecificRate`.  | [optional] 
+**unused_units_credit_rates** | **Number** | Per-unit rate at which to credit the customer for unused units. Only applicable if the value of the `overageUnusedUnitsCreditOption` field is `CreditBySpecificRate`. | [optional] 
 
 
 

package/docs/UsageVolumePricingOverride.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **price_change_option** | [**PriceChangeOption**](PriceChangeOption.md) |  | [optional] 
 **price_increase_percentage** | **Number** | Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`.  | [optional] 
-**rating_group** | **String** | Specifies how Zuora groups usage records when rating usage. See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group) for more information.   * ByBillingPeriod (default): The rating is based on all the usages in a billing period.   * ByUsageStartDate: The rating is based on all the usages on the same usage start date.    * ByUsageRecord: The rating is based on each usage record.   * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.  | [optional] 
+**rating_group** | **String** | Specifies how Zuora groups usage records when rating usage. See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group) for more information.   * ByBillingPeriod (default): The rating is based on all the usages in a billing period.   * ByUsageStartDate: The rating is based on all the usages on the same usage start date.    * ByUsageRecord: The rating is based on each usage record.   * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file. | [optional] 
 **tiers** | [**[ChargeTier]**](ChargeTier.md) | List of variable pricing tiers in the charge.  | [optional] 
 **uom** | **String** | Unit of measure of the standalone charge.  **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.  | [optional] 
 

package/docs/VerifyPaymentMethodRequest.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **currency_code** | **String** | The currency used for payment method authorization.   | [optional] 
 **gateway_options** | [**GatewayOptions**](GatewayOptions.md) |  | [optional] 
-**payment_gateway_name** | **String** | The name of the payment gateway instance. If no value is specified for this field, the default payment gateway of the customer account will be used.  | [optional] 
-**security_code** | **String** | The CVV or CVV2 security code for the credit card or debit card. To ensure PCI compliance, the value of this field is not stored and cannot be queried.  | [optional] 
+**payment_gateway_name** | **String** | The name of the payment gateway instance. If no value is specified for this field, the default payment gateway of the customer account will be used. | [optional] 
+**security_code** | **String** | The CVV or CVV2 security code for the credit card or debit card. To ensure PCI compliance, the value of this field is not stored and cannot be queried. | [optional] 
 
 

package/docs/WorkflowDefinition.md

@@ -5,16 +5,16 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **active_version** | [**WorkflowDefinitionActiveVersion**](WorkflowDefinitionActiveVersion.md) |  | [optional] 
-**callout_trigger** | **Boolean** | Indicates whether the callout trigger is enabled for the retrieved workflow.  | [optional] 
-**created_at** | **String** | The date and time when the workflow is created, in the `YYYY-MM-DD HH:MM:SS` format.  | [optional] 
+**callout_trigger** | **Boolean** | Indicates whether the callout trigger is enabled for the retrieved workflow. | [optional] 
+**created_at** | **String** | The date and time when the workflow is created, in the `YYYY-MM-DD HH:MM:SS` format. | [optional] 
 **description** | **String** | The description of the workflow definition.  | [optional] 
 **id** | **Number** | The unique ID of the workflow definition.  | [optional] 
-**interval** | **String** | The schedule of the workflow, in a CRON expression. Returns null if the schedued trigger is disabled.  | [optional] 
+**interval** | **String** | The schedule of the workflow, in a CRON expression. Returns null if the schedued trigger is disabled. | [optional] 
 **name** | **String** | The name of the workflow definition.  | [optional] 
 **ondemand_trigger** | **Boolean** | Indicates whether the ondemand trigger is enabled for the workflow.  | [optional] 
 **scheduled_trigger** | **Boolean** | Indicates whether the scheduled trigger is enabled for the workflow.  | [optional] 
 **status** | **String** | The status of the workflow definition.  | [optional] 
-**timezone** | **String** | The timezone that is configured for the scheduler of the workflow. Returns null if the scheduled trigger is disabled.  | [optional] 
-**updated_at** | **String** | The date and time when the workflow is updated the last time, in the `YYYY-MM-DD HH:MM:SS` format.  | [optional] 
+**timezone** | **String** | The timezone that is configured for the scheduler of the workflow. Returns null if the scheduled trigger is disabled. | [optional] 
+**updated_at** | **String** | The date and time when the workflow is updated the last time, in the `YYYY-MM-DD HH:MM:SS` format. | [optional] 
 
 

package/docs/WorkflowDefinitionAndVersions.md

@@ -5,17 +5,17 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **active_version** | [**WorkflowDefinitionActiveVersion**](WorkflowDefinitionActiveVersion.md) |  | [optional] 
-**callout_trigger** | **Boolean** | Indicates whether the callout trigger is enabled for the retrieved workflow.  | [optional] 
-**created_at** | **String** | The date and time when the workflow is created, in the `YYYY-MM-DD HH:MM:SS` format.  | [optional] 
+**callout_trigger** | **Boolean** | Indicates whether the callout trigger is enabled for the retrieved workflow. | [optional] 
+**created_at** | **String** | The date and time when the workflow is created, in the `YYYY-MM-DD HH:MM:SS` format. | [optional] 
 **description** | **String** | The description of the workflow definition.  | [optional] 
 **id** | **Number** | The unique ID of the workflow definition.  | [optional] 
-**interval** | **String** | The schedule of the workflow, in a CRON expression. Returns null if the schedued trigger is disabled.  | [optional] 
-**latest_inactive_verisons** | [**[Workflow]**](Workflow.md) | The list of inactive workflow versions retrieved. Maximum number of versions retrieved is 10.    | [optional] 
+**interval** | **String** | The schedule of the workflow, in a CRON expression. Returns null if the schedued trigger is disabled. | [optional] 
+**latest_inactive_verisons** | [**[Workflow]**](Workflow.md) | The list of inactive workflow versions retrieved. Maximum number of versions retrieved is 10.   | [optional] 
 **name** | **String** | The name of the workflow definition.  | [optional] 
 **ondemand_trigger** | **Boolean** | Indicates whether the ondemand trigger is enabled for the workflow.  | [optional] 
 **scheduled_trigger** | **Boolean** | Indicates whether the scheduled trigger is enabled for the workflow.  | [optional] 
 **status** | **String** | The status of the workflow definition.  | [optional] 
-**timezone** | **String** | The timezone that is configured for the scheduler of the workflow. Returns null if the scheduled trigger is disabled.  | [optional] 
-**updated_at** | **String** | The date and time when the workflow is updated the last time, in the `YYYY-MM-DD HH:MM:SS` format.  | [optional] 
+**timezone** | **String** | The timezone that is configured for the scheduler of the workflow. Returns null if the scheduled trigger is disabled. | [optional] 
+**updated_at** | **String** | The date and time when the workflow is updated the last time, in the `YYYY-MM-DD HH:MM:SS` format. | [optional]