npm - zuora-sdk-js - Versions diffs - 3.6.0 → 3.7.0 - Mend

zuora-sdk-js 3.6.0 → 3.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3385) hide show

package/docs/SequenceSetsApi.md CHANGED Viewed

@@ -96,7 +96,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 let apiInstance = new ZuoraSdkJs.SequenceSetsApi();
-let id = "id_example"; // String | The ID of the sequence set to delete.
+let id = "id_example"; // String | The ID of the sequence set to delete.
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
   'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
@@ -119,7 +119,7 @@ apiInstance.deleteSequenceSet(id, opts).then((data) => {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **id** | **String**| The ID of the sequence set to delete.  |
+ **id** | **String**| The ID of the sequence set to delete. |
  **accept_encoding** | **String**| Include the &#x60;Accept-Encoding: gzip&#x60; header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a &#x60;Content-Encoding&#x60; header with the compression algorithm so that your client can decompress it.  | [optional]
  **content_encoding** | **String**| Include the &#x60;Content-Encoding: gzip&#x60; header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.  | [optional]
  **authorization** | **String**| The value is in the &#x60;Bearer {token}&#x60; format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).  | [optional]
@@ -160,7 +160,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 let apiInstance = new ZuoraSdkJs.SequenceSetsApi();
-let id = "id_example"; // String | The ID of the sequence set to retrieve information about.
+let id = "id_example"; // String | The ID of the sequence set to retrieve information about.
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
   'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
@@ -183,7 +183,7 @@ apiInstance.getSequenceSet(id, opts).then((data) => {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **id** | **String**| The ID of the sequence set to retrieve information about.  |
+ **id** | **String**| The ID of the sequence set to retrieve information about. |
  **accept_encoding** | **String**| Include the &#x60;Accept-Encoding: gzip&#x60; header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a &#x60;Content-Encoding&#x60; header with the compression algorithm so that your client can decompress it.  | [optional]
  **content_encoding** | **String**| Include the &#x60;Content-Encoding: gzip&#x60; header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.  | [optional]
  **authorization** | **String**| The value is in the &#x60;Bearer {token}&#x60; format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).  | [optional]
@@ -232,7 +232,7 @@ let opts = {
   'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.  The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
   'page_size': 20, // Number | The number of records returned per page in the response.
   'page': 1, // Number | The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.
-  'name': "name_example", // String | The name of a specific sequence set.
+  'name': "name_example", // String | The name of a specific sequence set.
   'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
   'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
 };
@@ -256,7 +256,7 @@ Name | Type | Description  | Notes
  **zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.  The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (&#x60;:&#x60;), semicolon (&#x60;;&#x60;), double quote (&#x60;\&quot;&#x60;), and quote (&#x60;&#39;&#x60;).  | [optional]
  **page_size** | **Number**| The number of records returned per page in the response.  | [optional] [default to 20]
  **page** | **Number**| The index number of the page that you want to retrieve. This parameter is dependent on &#x60;pageSize&#x60;. You must set &#x60;pageSize&#x60; before specifying &#x60;page&#x60;. For example, if you set &#x60;pageSize&#x60; to &#x60;20&#x60; and &#x60;page&#x60; to &#x60;2&#x60;, the 21st to 40th records are returned in the response.  | [optional] [default to 1]
- **name** | **String**| The name of a specific sequence set.  | [optional]
+ **name** | **String**| The name of a specific sequence set. | [optional]
  **zuora_version** | **String**| The minor version of the Zuora REST API.   | [optional] [default to &#39;2024-05-20&#39;]
  **zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user&#39;s accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user&#39;s accessible orgs.  | [optional]
@@ -292,7 +292,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 let apiInstance = new ZuoraSdkJs.SequenceSetsApi();
-let id = "id_example"; // String | The ID of the sequence set to update.
+let id = "id_example"; // String | The ID of the sequence set to update.
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
   'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
@@ -316,7 +316,7 @@ apiInstance.updateSequenceSet(id, opts).then((data) => {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **id** | **String**| The ID of the sequence set to update.  |
+ **id** | **String**| The ID of the sequence set to update. |
  **accept_encoding** | **String**| Include the &#x60;Accept-Encoding: gzip&#x60; header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a &#x60;Content-Encoding&#x60; header with the compression algorithm so that your client can decompress it.  | [optional]
  **content_encoding** | **String**| Include the &#x60;Content-Encoding: gzip&#x60; header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.  | [optional]
  **authorization** | **String**| The value is in the &#x60;Bearer {token}&#x60; format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).  | [optional]

package/docs/ServiceProviderResponse.md CHANGED Viewed

@@ -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]
 **id** | **String** | The ID of the e-invoicing service provider.  | [optional]
 **name** | **String** | The name of the e-invoicing service provider.  | [optional]
 **test** | **Boolean** | Whether the e-invoicing service provider&#39;s configuration is intended for testing.   - If you set this field to &#x60;true&#x60;, requests are directed to the testing integration endpoints. If you set this field to &#x60;false&#x60;, requests are directed to the production integration endpoints.  | [optional]

package/docs/SettingsApi.md CHANGED Viewed

@@ -33,7 +33,7 @@ let opts = {
   'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).
   'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
   'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.  The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
-  'accept': "accept_example", // String | Specifies response media type. If you omit the `Accept` header parameter, the response body is by default in JSON format. If you include `Accept` header parameter and set it to `application/csv`, the response body is in csv format.
+  'accept': "accept_example", // String | Specifies response media type. If you omit the `Accept` header parameter, the response body is by default in JSON format. If you include `Accept` header parameter and set it to `application/csv`, the response body is in csv format.
   'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
   'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
 };
@@ -55,7 +55,7 @@ Name | Type | Description  | Notes
  **authorization** | **String**| The value is in the &#x60;Bearer {token}&#x60; format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).  | [optional]
  **zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  | [optional]
  **zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.  The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (&#x60;:&#x60;), semicolon (&#x60;;&#x60;), double quote (&#x60;\&quot;&#x60;), and quote (&#x60;&#39;&#x60;).  | [optional]
- **accept** | **String**| Specifies response media type. If you omit the &#x60;Accept&#x60; header parameter, the response body is by default in JSON format. If you include &#x60;Accept&#x60; header parameter and set it to &#x60;application/csv&#x60;, the response body is in csv format.  | [optional]
+ **accept** | **String**| Specifies response media type. If you omit the &#x60;Accept&#x60; header parameter, the response body is by default in JSON format. If you include &#x60;Accept&#x60; header parameter and set it to &#x60;application/csv&#x60;, the response body is in csv format. | [optional]
  **zuora_version** | **String**| The minor version of the Zuora REST API.   | [optional] [default to &#39;2024-05-20&#39;]
  **zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user&#39;s accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user&#39;s accessible orgs.  | [optional]
@@ -79,7 +79,7 @@ Name | Type | Description  | Notes
 Submit settings requests
-Submit a batch of settings requests by this single API operation.  By default, one batch settings request can contain a maximum of 100 single operation requests, including:  * All the single requests in the process batch settings request. * All the children requests of the single requests.  This maximum value is configurable.
+Submit a batch of settings requests by this single API operation. nBy default, one batch settings request can contain a maximum of 100 single operation requests, including:  * All the single requests in the process batch settings request. * All the children requests of the single requests.  This maximum value is configurable.
 ### Example

package/docs/SettlePaymentRequest.md CHANGED Viewed

@@ -7,6 +7,6 @@ Name | Type | Description | Notes
 **gateway_reconciliation_reason** | **String** | The reason of gateway reconciliation.  | [optional]
 **gateway_reconciliation_status** | **String** | The status of gateway reconciliation.  | [optional]
 **payout_id** | **String** | The payout ID from the gateway side.  | [optional]
-**settled_on** | **String** | The date and time of the transaction settlement. The format is &#x60;yyyy-mm-dd hh:mm:ss&#x60;.  | [optional]
+**settled_on** | **String** | The date and time of the transaction settlement. The format is &#x60;yyyy-mm-dd hh:mm:ss&#x60;. | [optional]

package/docs/SignUpApi.md CHANGED Viewed

@@ -14,7 +14,7 @@ Method | HTTP request | Description
 Sign up
-This call performs many actions. You can use this operation to implement the standard requirements for signing up a customer, such as validating the uniqueness of an account and limiting the number of subscriptions per account. Also, you can use this operation to create a subscription, generate an invoice, and collect payment for a new or existing customer.   **Note:** You need to have the [Orders](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders/Orders_Harmonization) feature enabled to use this API.  For a new customer, you can perform the following tasks in one call. Note that you can skip creating a payment meethod and still get the subscription and invoice successfully created. * Create an account * Create a payment method * Subscribe to a product in the product catalog and create a subscription * Generate an invoice * Collect payment  For an existing customer, you can use an account identification field of an external system to specify the account.  You can make [make asynchronous requests](https://www.zuora.com/developer/rest-api/general-concepts/async-requests/) when using the \&quot;Sign up\&quot; operation.
+This call performs many actions. You can use this operation to implement the standard requirements for signing up a customer, such as validating the uniqueness of an account and limiting the number of subscriptions per account. Also, you can use this operation to create a subscription, generate an invoice, and collect payment for a new or existing customer.   **Note:** You need to have the [Orders](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders/Orders_Harmonization) feature enabled to use this API.  For a new customer, you can perform the following tasks in one call. Note that you can skip creating a payment meethod and still get the subscription and invoice successfully created. * Create an account * Create a payment method * Subscribe to a product in the product catalog and create a subscription * Generate an invoice * Collect payment nFor an existing customer, you can use an account identification field of an external system to specify the account.  You can make [make asynchronous requests](https://www.zuora.com/developer/rest-api/general-concepts/async-requests/) when using the \&quot;Sign up\&quot; operation.
 ### Example

package/docs/SignUpCreatePMPayPalECPayPalNativeEC.md CHANGED Viewed

@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **BAID** | **String** | ID of a PayPal billing agreement, for example, I-1TJ3GAGG82Y9.  | [optional]
-**email** | **String** | Email address associated with the payment method. This field is only supported for PayPal payment methods and is required if you want to create any of the following PayPal payment methods:   - PayPal Express Checkout payment method    - PayPal Adaptive payment method   - PayPal Commerce Platform payment method  | [optional]
+**email** | **String** | Email address associated with the payment method. This field is only supported for PayPal payment methods and is required if you want to create any of the following PayPal payment methods:   - PayPal Express Checkout payment method    - PayPal Adaptive payment method   - PayPal Commerce Platform payment method | [optional]

package/docs/SignUpCreatePaymentMethodCardholderInfo.md CHANGED Viewed

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **address_line1** | **String** | First address line, 255 characters or less.  | [optional]
 **address_line2** | **String** | Second address line, 255 characters or less.  | [optional]
-**card_holder_name** | **String** | The card holder&#39;s full name as it appears on the card, e.g., \&quot;John J Smith\&quot;, 50 characters or less.  |
+**card_holder_name** | **String** | The card holder&#39;s full name as it appears on the card, e.g., \&quot;John J Smith\&quot;, 50 characters or less. |
 **city** | **String** | City, 40 characters or less.  | [optional]
 **country** | **String** | Country, must be a valid country name or abbreviation.  | [optional]
 **email** | **String** | Card holder&#39;s email address, 80 characters or less.  | [optional]

package/docs/SignUpCreatePaymentMethodCommon.md CHANGED Viewed

@@ -5,8 +5,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **account_key** | **String** | Internal ID of the customer account that will own the payment method.  | [optional]
-**auth_gateway** | **String** | Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method.  If you do not set this field, Zuora will use one of the following payment gateways instead:  * The default payment gateway of the customer account that owns the payment method, if the &#x60;accountKey&#x60; field is set. * The default payment gateway of your Zuora tenant, if the &#x60;accountKey&#x60; field is not set.  | [optional]
-**ip_address** | **String** | The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways.   If the IP address length is beyond 45 characters, a validation error occurs.  | [optional]
-**make_default** | **Boolean** | Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the &#x60;accountKey&#x60; field is set.  | [optional] [default to false]
+**auth_gateway** | **String** | Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method.   If you do not set this field, Zuora will use one of the following payment gateways instead:   * The default payment gateway of the customer account that owns the payment method, if the &#x60;accountKey&#x60; field is set.  * The default payment gateway of your Zuora tenant, if the &#x60;accountKey&#x60; field is not set. | [optional]
+**ip_address** | **String** | The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways.    If the IP address length is beyond 45 characters, a validation error occurs. | [optional]
+**make_default** | **Boolean** | Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the &#x60;accountKey&#x60; field is set. | [optional] [default to false]

package/docs/SignUpCreatePaymentMethodCreditCardReferenceTransaction.md CHANGED Viewed

@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **second_token_id** | **String** | The second token id of CreditCardReferenceTransaction.  | [optional]
-**token_id** | **String** | The token id of payment method, required field of CreditCardReferenceTransaction type.  | [optional]
+**token_id** | **String** | The token id of payment method, required field of CreditCardReferenceTransaction type. | [optional]

package/docs/SignUpPaymentMethod.md CHANGED Viewed

@@ -5,9 +5,9 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **second_token_id** | **String** | The second token id of CreditCardReferenceTransaction.  | [optional]
-**token_id** | **String** | The token id of payment method, required field of CreditCardReferenceTransaction type.  | [optional]
+**token_id** | **String** | The token id of payment method, required field of CreditCardReferenceTransaction type. | [optional]
 **BAID** | **String** | ID of a PayPal billing agreement, for example, I-1TJ3GAGG82Y9.  | [optional]
-**email** | **String** | Email address associated with the payment method. This field is only supported for PayPal payment methods and is required if you want to create any of the following PayPal payment methods:   - PayPal Express Checkout payment method    - PayPal Adaptive payment method   - PayPal Commerce Platform payment method  | [optional]
+**email** | **String** | Email address associated with the payment method. This field is only supported for PayPal payment methods and is required if you want to create any of the following PayPal payment methods:   - PayPal Express Checkout payment method    - PayPal Adaptive payment method   - PayPal Commerce Platform payment method | [optional]
 **preapproval_key** | **String** | The PayPal preapproval key.  | [optional]
 **card_holder_info** | [**SignUpCreatePaymentMethodCardholderInfo**](SignUpCreatePaymentMethodCardholderInfo.md) |  | [optional]
 **card_number** | **String** | Credit card number.  | [optional]
@@ -23,10 +23,10 @@ Name | Type | Description | Notes
 **mit_profile_type** | [**SignUpCreatePaymentMethodCreditCardMitProfileType**](SignUpCreatePaymentMethodCreditCardMitProfileType.md) |  | [optional]
 **security_code** | **String** | CVV or CVV2 security code of the credit card.  To ensure PCI compliance, this value is not stored and cannot be queried.  | [optional]
 **account_key** | **String** | Internal ID of the customer account that will own the payment method.  | [optional]
-**auth_gateway** | **String** | Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method.  If you do not set this field, Zuora will use one of the following payment gateways instead:  * The default payment gateway of the customer account that owns the payment method, if the &#x60;accountKey&#x60; field is set. * The default payment gateway of your Zuora tenant, if the &#x60;accountKey&#x60; field is not set.  | [optional]
-**ip_address** | **String** | The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways.   If the IP address length is beyond 45 characters, a validation error occurs.  | [optional]
-**make_default** | **Boolean** | Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the &#x60;accountKey&#x60; field is set.  | [optional] [default to false]
-**type** | **String** | Type of payment method. The following types of the payment method are supported:  |
+**auth_gateway** | **String** | Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method.   If you do not set this field, Zuora will use one of the following payment gateways instead:   * The default payment gateway of the customer account that owns the payment method, if the &#x60;accountKey&#x60; field is set.  * The default payment gateway of your Zuora tenant, if the &#x60;accountKey&#x60; field is not set. | [optional]
+**ip_address** | **String** | The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways.    If the IP address length is beyond 45 characters, a validation error occurs. | [optional]
+**make_default** | **Boolean** | Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the &#x60;accountKey&#x60; field is set. | [optional] [default to false]
+**type** | **String** | Type of payment method. The following types of the payment method are supported: |

package/docs/SubmitDataLabelingJobRequest.md CHANGED Viewed

@@ -4,12 +4,12 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**ids** | **[String]** | The IDs of the objects to be labeled, only required if the &#x60;queryType&#x60; is &#x60;ById&#x60;.  There is a 4MB limit of the JSON payload, so in case of a large number of IDs, please make sure the payload is less than 4MB.  | [optional]
+**ids** | **[String]** | The IDs of the objects to be labeled, only required if the &#x60;queryType&#x60; is &#x60;ById&#x60;.   There is a 4MB limit of the JSON payload, so in case of a large number of IDs, please make sure the payload is less than 4MB. | [optional]
 **object_type** | **String** | The object type of the data labeling job.  Currently, the following objects are supported:   * &#x60;User&#x60;   * &#x60;Account&#x60;       All the associated transaction objects of the account being labeled will automatically inherit the org label of the account.   * &#x60;Product&#x60;      You have to label the Account object first, make sure all accounts have been labeled, then you can proceed with the Product object.       You can get all the unlabeled accounts by running a Data Source export job, with the following query:     &#x60;&#x60;&#x60; sql     SELECT Id, Name FROM Account WHERE Organization.Id IS NULL     &#x60;&#x60;&#x60;                        All the ProductRatePlanS of the product will be automatically labeled with the same &#x60;orgs&#x60;.          When labeling products, you can omit the &#x60;orgs&#x60; parameter, i.e, leave it empty, the system will find all the subscriptions that include the product and get the org list of those subscriptions, then label the product with those &#x60;orgs&#x60;, aka, the &#x60;derived orgs&#x60;.          You can also explicitly specify the orgs parameter, in that case, you will need to provide a super set of the &#x60;derived orgs&#x60;.     * &#x60;BillRun&#x60;      You don&#39;t need to specify the &#x60;orgs&#x60; parameter, we will label the &#x60;BillRun&#x60; with all the orgs because existing runs could pick up all accounts. You can definitely create new bill run with certain &#x60;orgs&#x60; to operate separately by &#x60;orgs&#x60;.   * &#x60;PaymentRun&#x60;      Same as BillRun.   * &#x60;ForecastRun&#x60;  |
-**org_ids** | **[String]** | The IDs of the organizations that the data labeling job will associate with the data to be labeled. Either the &#x60;orgIds&#x60; or &#x60;orgs&#x60; field is required.  For &#x60;Account&#x60; object, one and only one org Id is required.  For configuration objects, &#x60;null&#x60; and &#x60;[]&#x60; are treated differently, use &#x60;null&#x60; to unlabel the object, &#x60;[]&#x60; to label it with all orgs.  | [optional]
-**orgs** | **[String]** | The names of the organizations that the data labeling job will associate with the data to be labeled. Either the &#x60;orgIds&#x60; or &#x60;orgs&#x60; field is required.  For &#x60;Account&#x60; object, one and only one org name is required.  For configuration objects, &#x60;null&#x60; and &#x60;[]&#x60; are treated differently, use &#x60;null&#x60; to unlabel the object, &#x60;[]&#x60; to label it with all orgs.  | [optional]
-**query** | **String** | The query that the data labeling job will run to fetch the data to be labeled, only required if the &#x60;queryType&#x60; is &#x60;ByZoql&#x60;.  | [optional]
-**query_type** | **String** | Specifies the type of query that the data labeling job will run to fetch the data to be labeled.  * &#x60;ByZoql&#x60; - The data labeling job will run a ZOQL query which is specified in the &#x60;query&#x60; field to fetch the data to be labeled. * &#x60;ById&#x60; - The data labeling job will fetch the data to be labeled by the IDs specified in the &#x60;ids&#x60; field.  |
+**org_ids** | **[String]** | The IDs of the organizations that the data labeling job will associate with the data to be labeled. Either the &#x60;orgIds&#x60; or &#x60;orgs&#x60; field is required.   For &#x60;Account&#x60; object, one and only one org Id is required.   For configuration objects, &#x60;null&#x60; and &#x60;[]&#x60; are treated differently, use &#x60;null&#x60; to unlabel the object, &#x60;[]&#x60; to label it with all orgs. | [optional]
+**orgs** | **[String]** | The names of the organizations that the data labeling job will associate with the data to be labeled. Either the &#x60;orgIds&#x60; or &#x60;orgs&#x60; field is required.   For &#x60;Account&#x60; object, one and only one org name is required.   For configuration objects, &#x60;null&#x60; and &#x60;[]&#x60; are treated differently, use &#x60;null&#x60; to unlabel the object, &#x60;[]&#x60; to label it with all orgs. | [optional]
+**query** | **String** | The query that the data labeling job will run to fetch the data to be labeled, only required if the &#x60;queryType&#x60; is &#x60;ByZoql&#x60;. | [optional]
+**query_type** | **String** | Specifies the type of query that the data labeling job will run to fetch the data to be labeled.   * &#x60;ByZoql&#x60; - The data labeling job will run a ZOQL query which is specified in the &#x60;query&#x60; field to fetch the data to be labeled.  * &#x60;ById&#x60; - The data labeling job will fetch the data to be labeled by the IDs specified in the &#x60;ids&#x60; field. |

package/docs/SubmitDataLabelingJobResponse.md CHANGED Viewed

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **job_id** | **String** | Identifier of the data labeling job.  | [optional]
-**job_status** | **String** | Status of the data labeling job.  * &#x60;Accepted&#x60; - The data labeling job has been accepted by the system. * &#x60;Dispatched&#x60; - The data labeling job is dispatched to the data labeling service. * &#x60;Completed&#x60; - The data labeling job has completed. Please note that &#x60;Completed&#x60; simply means the data labeling job has completed, but it does not mean the data labeling job has labeled all the data. You can check the &#x60;progress&#x60; field to see how many data have been &#x60;labeled&#x60;, &#x60;failed&#x60; or &#x60;timeout&#x60;.  | [optional]
+**job_status** | **String** | Status of the data labeling job.   * &#x60;Accepted&#x60; - The data labeling job has been accepted by the system.  * &#x60;Dispatched&#x60; - The data labeling job is dispatched to the data labeling service.  * &#x60;Completed&#x60; - The data labeling job has completed. Please note that &#x60;Completed&#x60; simply means the data labeling job has completed, but it does not mean the data labeling job has labeled all the data. You can check the &#x60;progress&#x60; field to see how many data have been &#x60;labeled&#x60;, &#x60;failed&#x60; or &#x60;timeout&#x60;. | [optional]
 **success** | **Boolean** | Indicates whether the job was submitted successfully.  | [optional]

package/docs/SubscriptionCreditMemoItem.md CHANGED Viewed

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **amount_without_tax** | **Number** | The credit memo item amount excluding tax.  | [optional]
-**charge_amount** | **Number** | The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax  | [optional]
+**charge_amount** | **Number** | The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax | [optional]
 **charge_description** | **String** | Description of this credit memo item.  | [optional]
 **charge_name** | **String** | Name of this credit memo item.  | [optional]
 **product_name** | **String** | Name of the product associated with this credit memo item.  | [optional]
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 **service_end_date** | **String** | End date of the service period for this credit memo item, as yyyy-mm-dd.  | [optional]
 **service_start_date** | **String** | Service start date of this credit memo item, as yyyy-mm-dd.  | [optional]
 **tax_amount** | **Number** | The tax amount of the credit memo item.  | [optional]
-**taxation_items** | [**[SubscriptionTaxationItem]**](SubscriptionTaxationItem.md) | List of taxation items. **Note**: This field is only available if you set the &#x60;zuora-version&#x60; request header to &#x60;315.0&#x60; or later.  | [optional]
+**taxation_items** | [**[SubscriptionTaxationItem]**](SubscriptionTaxationItem.md) | List of taxation items.  **Note**: This field is only available if you set the &#x60;zuora-version&#x60; request header to &#x60;315.0&#x60; or later.  | [optional]
 **unit_of_measure** | **String** | Unit used to measure consumption. | [optional]

package/docs/SubscriptionData.md CHANGED Viewed

@@ -5,11 +5,11 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **custom_fields** | **{String: Object}** | Container for custom fields.  | [optional]
-**invoice_separately** | **Boolean** | Specifies whether the subscription appears on a separate invoice when Zuora generates invoices.  | [optional]
+**invoice_separately** | **Boolean** | Specifies whether the subscription appears on a separate invoice when Zuora generates invoices. | [optional]
 **notes** | **String** | Notes about the subscription. These notes are only visible to Zuora users.  | [optional]
 **rate_plans** | [**[RatePlan]**](RatePlan.md) |  | [optional]
 **start_date** | **String** |  | [optional]
-**subscription_number** | **String** | Subscription number of the subscription to create, for example, A-S00000001.  If you do not set this field, Zuora will generate a subscription number.  | [optional]
+**subscription_number** | **String** | Subscription number of the subscription to create, for example, A-S00000001.   If you do not set this field, Zuora will generate a subscription number. | [optional]
 **terms** | [**TermInfo**](TermInfo.md) |  | [optional]

package/docs/SubscriptionObjectNSFields.md CHANGED Viewed

@@ -4,10 +4,10 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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&#x3D;265).  | [optional]
-**integration_status__ns** | **String** | Status of the subscription&#39;s synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId&#x3D;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&#x3D;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&#x3D;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&#x3D;265).  | [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&#x3D;265). | [optional]
+**integration_status__ns** | **String** | Status of the subscription&#39;s synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId&#x3D;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&#x3D;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&#x3D;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&#x3D;265). | [optional]

package/docs/SubscriptionObjectQTFields.md CHANGED Viewed

@@ -4,11 +4,11 @@
 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]
+**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]

package/docs/SubscriptionRatePlan.md CHANGED Viewed

@@ -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:   * &#x60;Add&#x60;   * &#x60;Update&#x60;   * &#x60;Remove&#x60;  | [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:   * &#x60;Add&#x60;   * &#x60;Update&#x60;   * &#x60;Remove&#x60; | [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/SubscriptionsApi.md CHANGED Viewed

@@ -310,6 +310,7 @@ let opts = {
   'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
   'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
   'charge_detail': "charge_detail_example", // String |  The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges.  Possible values are:   * __last-segment__: (Default) The last rate plan charge on the subscription. The last rate plan charge is the last one in the order of time on the subscription rather than the most recent changed charge on the subscription.  * __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date < effectiveEndDate).    * __all-segments__: All the segmented charges. The `chargeSegments` field is returned in the response. The `chargeSegments` field contains an array of the charge information for all the charge segments.   * __specific-segment&as-of-date=date__: The segmented charge that is active on a date you specified ((specific date = effectiveStartDate) OR (effectiveStartDate < specific date < effectiveEndDate)). The format of the date is yyyy-mm-dd.
+  'as_of_date': "as_of_date_example", // String | The date for charge-detail. Only available when `charge-detail` is `specific-segment`. The date should be in the format `YYYY-MM-DD`.
   'exclude_rate_plans_with_no_charges': true, // Boolean | If the `exclude-rate-plans-with-no-charges` is `true`, only the active charges and rate plans will be in the response. The default value is `false`.
   'get_detailed_metrics': true, // Boolean | If the `getDetailedMetrics` is `true`, `contractedNetMrr`, `asOfDayGrossMrr`, `asOfDayNetMrr` will be in the response.  The default value is `false`.
   'as_of_day': "as_of_day_example", // String | The date for metrics. The date should be in the format `YYYY-MM-DD`.  The default value is the current date.
@@ -338,6 +339,7 @@ Name | Type | Description  | Notes
  **zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  | [optional]
  **zuora_version** | **String**| The minor version of the Zuora REST API.   | [optional] [default to &#39;2024-05-20&#39;]
  **charge_detail** | **String**|  The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges.  Possible values are:   * __last-segment__: (Default) The last rate plan charge on the subscription. The last rate plan charge is the last one in the order of time on the subscription rather than the most recent changed charge on the subscription.  * __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate &lt;&#x3D; today’s date &lt; effectiveEndDate).    * __all-segments__: All the segmented charges. The &#x60;chargeSegments&#x60; field is returned in the response. The &#x60;chargeSegments&#x60; field contains an array of the charge information for all the charge segments.   * __specific-segment&amp;as-of-date&#x3D;date__: The segmented charge that is active on a date you specified ((specific date &#x3D; effectiveStartDate) OR (effectiveStartDate &lt; specific date &lt; effectiveEndDate)). The format of the date is yyyy-mm-dd.  | [optional]
+ **as_of_date** | **String**| The date for charge-detail. Only available when &#x60;charge-detail&#x60; is &#x60;specific-segment&#x60;. The date should be in the format &#x60;YYYY-MM-DD&#x60;.   | [optional]
  **exclude_rate_plans_with_no_charges** | **Boolean**| If the &#x60;exclude-rate-plans-with-no-charges&#x60; is &#x60;true&#x60;, only the active charges and rate plans will be in the response. The default value is &#x60;false&#x60;.  | [optional]
  **get_detailed_metrics** | **Boolean**| If the &#x60;getDetailedMetrics&#x60; is &#x60;true&#x60;, &#x60;contractedNetMrr&#x60;, &#x60;asOfDayGrossMrr&#x60;, &#x60;asOfDayNetMrr&#x60; will be in the response.  The default value is &#x60;false&#x60;.  | [optional]
  **as_of_day** | **String**| The date for metrics. The date should be in the format &#x60;YYYY-MM-DD&#x60;.  The default value is the current date.   | [optional]
@@ -377,8 +379,8 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 let apiInstance = new ZuoraSdkJs.SubscriptionsApi();
-let subscription_key = "subscription_key_example"; // String | Subscription number. For example, A-S00000135.
-let version = "version_example"; // String | Subscription version. For example, 1.
+let subscription_key = "subscription_key_example"; // String | Subscription number. For example, A-S00000135.
+let version = "version_example"; // String | Subscription version. For example, 1.
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
   'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
@@ -386,9 +388,10 @@ let opts = {
   'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.  The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).
   'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
   'charge_detail': "charge_detail_example", // String |  The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges.  Possible values are:   * __last-segment__: (Default) The last rate plan charge on the subscription. The last rate plan charge is the last one in the order of time on the subscription rather than the most recent changed charge on the subscription.  * __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date < effectiveEndDate).    * __all-segments__: All the segmented charges. The `chargeSegments` field is returned in the response. The `chargeSegments` field contains an array of the charge information for all the charge segments.   * __specific-segment&as-of-date=date__: The segmented charge that is active on a date you specified (effectiveStartDate <= specific date < effectiveEndDate). The format of the date is yyyy-mm-dd.
-  'exclude_rate_plans_with_no_charges': true, // Boolean | If the `exclude-rate-plans-with-no-charges` is `true`, only the active charges and rate plans will be in the response. The default value is `false`.
-  'get_detailed_metrics': true, // Boolean |  If the `getDetailedMetrics` is `true`, `contractedNetMrr`, `asOfDayGrossMrr`, `asOfDayNetMrr` will be in the response. The default value is `false`.
-  'as_of_day': "as_of_day_example", // String |  The date for detailed metrics. Only available when `getDetailedMetrics` is `true`. The date should be in the format `YYYY-MM-DD`. The default value is the current date.
+  'as_of_date': "as_of_date_example", // String |  The date for charge-detail. Only available when `charge-detail` is `specific-segment`. The date should be in the format `YYYY-MM-DD`.
+  'exclude_rate_plans_with_no_charges': true, // Boolean | If the `exclude-rate-plans-with-no-charges` is `true`, only the active charges and rate plans will be in the response. The default value is `false`.
+  'get_detailed_metrics': true, // Boolean |  If the `getDetailedMetrics` is `true`, `contractedNetMrr`, `asOfDayGrossMrr`, `asOfDayNetMrr` will be in the response. The default value is `false`.
+  'as_of_day': "as_of_day_example", // String |  The date for detailed metrics. Only available when `getDetailedMetrics` is `true`. The date should be in the format `YYYY-MM-DD`. The default value is the current date.
   'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
   'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
 };
@@ -405,17 +408,18 @@ apiInstance.getSubscriptionByKeyAndVersion(subscription_key, version, opts).then
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **subscription_key** | **String**| Subscription number. For example, A-S00000135.  |
- **version** | **String**| Subscription version. For example, 1.  |
+ **subscription_key** | **String**| Subscription number. For example, A-S00000135. |
+ **version** | **String**| Subscription version. For example, 1. |
  **accept_encoding** | **String**| Include the &#x60;Accept-Encoding: gzip&#x60; header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a &#x60;Content-Encoding&#x60; header with the compression algorithm so that your client can decompress it.  | [optional]
  **content_encoding** | **String**| Include the &#x60;Content-Encoding: gzip&#x60; header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.  | [optional]
  **authorization** | **String**| The value is in the &#x60;Bearer {token}&#x60; format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).  | [optional]
  **zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.  The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (&#x60;:&#x60;), semicolon (&#x60;;&#x60;), double quote (&#x60;\&quot;&#x60;), and quote (&#x60;&#39;&#x60;).  | [optional]
  **zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  | [optional]
  **charge_detail** | **String**|  The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges.  Possible values are:   * __last-segment__: (Default) The last rate plan charge on the subscription. The last rate plan charge is the last one in the order of time on the subscription rather than the most recent changed charge on the subscription.  * __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate &lt;&#x3D; today’s date &lt; effectiveEndDate).    * __all-segments__: All the segmented charges. The &#x60;chargeSegments&#x60; field is returned in the response. The &#x60;chargeSegments&#x60; field contains an array of the charge information for all the charge segments.   * __specific-segment&amp;as-of-date&#x3D;date__: The segmented charge that is active on a date you specified (effectiveStartDate &lt;&#x3D; specific date &lt; effectiveEndDate). The format of the date is yyyy-mm-dd.  | [optional]
- **exclude_rate_plans_with_no_charges** | **Boolean**| If the &#x60;exclude-rate-plans-with-no-charges&#x60; is &#x60;true&#x60;, only the active charges and rate plans will be in the response. The default value is &#x60;false&#x60;.  | [optional]
- **get_detailed_metrics** | **Boolean**|  If the &#x60;getDetailedMetrics&#x60; is &#x60;true&#x60;, &#x60;contractedNetMrr&#x60;, &#x60;asOfDayGrossMrr&#x60;, &#x60;asOfDayNetMrr&#x60; will be in the response. The default value is &#x60;false&#x60;.  | [optional]
- **as_of_day** | **String**|  The date for detailed metrics. Only available when &#x60;getDetailedMetrics&#x60; is &#x60;true&#x60;. The date should be in the format &#x60;YYYY-MM-DD&#x60;. The default value is the current date.  | [optional]
+ **as_of_date** | **String**|  The date for charge-detail. Only available when &#x60;charge-detail&#x60; is &#x60;specific-segment&#x60;. The date should be in the format &#x60;YYYY-MM-DD&#x60;. | [optional]
+ **exclude_rate_plans_with_no_charges** | **Boolean**| If the &#x60;exclude-rate-plans-with-no-charges&#x60; is &#x60;true&#x60;, only the active charges and rate plans will be in the response. The default value is &#x60;false&#x60;. | [optional]
+ **get_detailed_metrics** | **Boolean**|  If the &#x60;getDetailedMetrics&#x60; is &#x60;true&#x60;, &#x60;contractedNetMrr&#x60;, &#x60;asOfDayGrossMrr&#x60;, &#x60;asOfDayNetMrr&#x60; will be in the response. The default value is &#x60;false&#x60;. | [optional]
+ **as_of_day** | **String**|  The date for detailed metrics. Only available when &#x60;getDetailedMetrics&#x60; is &#x60;true&#x60;. The date should be in the format &#x60;YYYY-MM-DD&#x60;. The default value is the current date. | [optional]
  **zuora_version** | **String**| The minor version of the Zuora REST API.   | [optional] [default to &#39;2024-05-20&#39;]
  **zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user&#39;s accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user&#39;s accessible orgs.  | [optional]
@@ -451,7 +455,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 let apiInstance = new ZuoraSdkJs.SubscriptionsApi();
-let account_key = "account_key_example"; // String |  Possible values are: * an account number * an account ID
+let account_key = "account_key_example"; // String |  Possible values are: * an account number * an account ID
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
   'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
@@ -460,11 +464,12 @@ let opts = {
   'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
   'page': 1, // Number | The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.
   'page_size': 20, // Number | The number of records returned per page in the response.
-  'owner_type': "owner_type_example", // String |  Possible values are: * invoiceOwner * subscriptionOwner
-  'get_detailed_metrics': true, // Boolean |  If the `getDetailedMetrics` is `true`, `contractedNetMrr`, `asOfDayGrossMrr`, `asOfDayNetMrr` will be in the response. The default value is `false`.
-  'as_of_day': "as_of_day_example", // String |  The date for detailed metrics. Only available when `getDetailedMetrics` is `true`. The date should be in the format `YYYY-MM-DD`. The default value is the current date.
+  'owner_type': "owner_type_example", // String |  Possible values are: * invoiceOwner * subscriptionOwner
+  'get_detailed_metrics': true, // Boolean |  If the `getDetailedMetrics` is `true`, `contractedNetMrr`, `asOfDayGrossMrr`, `asOfDayNetMrr` will be in the response. The default value is `false`.
+  'as_of_day': "as_of_day_example", // String |  The date for detailed metrics. Only available when `getDetailedMetrics` is `true`. The date should be in the format `YYYY-MM-DD`. The default value is the current date.
   'charge_detail': "charge_detail_example", // String | The segmented rate plan charges.  When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges.  Possible values are:  * __last-segment__: (Default) The last rate plan charge on the subscription. The last rate plan charge is the last one in the order of time on the subscription rather than the most recent changed charge on the subscription.  * __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date < effectiveEndDate).    * __all-segments__: All the segmented charges. The `chargeSegments` field is returned in the response. The `chargeSegments` field contains an array of the charge information for all the charge segments.   * __specific-segment&as-of-date=date__: The segmented charge that is active on a date you specified (effectiveStartDate <= specific date < effectiveEndDate). The format of the date is yyyy-mm-dd.
-  'exclude_rate_plans_with_no_charges': true, // Boolean | If the `exclude-rate-plans-with-no-charges` is `true`, only the active charges and rate plans will be in the response. The default value is `false`.
+  'as_of_date': "as_of_date_example", // String |  The date for charge-detail. Only available when `charge-detail` is `specific-segment`. The date should be in the format `YYYY-MM-DD`.
+  'exclude_rate_plans_with_no_charges': true, // Boolean | If the `exclude-rate-plans-with-no-charges` is `true`, only the active charges and rate plans will be in the response. The default value is `false`.
   'zuora_version': "'2024-05-20'", // String | The minor version of the Zuora REST API.
   'zuora_org_ids': "zuora_org_ids_example" // String | Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
 };
@@ -481,7 +486,7 @@ apiInstance.getSubscriptionsByAccount(account_key, opts).then((data) => {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **account_key** | **String**|  Possible values are: * an account number * an account ID  |
+ **account_key** | **String**|  Possible values are: * an account number * an account ID |
  **accept_encoding** | **String**| Include the &#x60;Accept-Encoding: gzip&#x60; header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a &#x60;Content-Encoding&#x60; header with the compression algorithm so that your client can decompress it.  | [optional]
  **content_encoding** | **String**| Include the &#x60;Content-Encoding: gzip&#x60; header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.  | [optional]
  **authorization** | **String**| The value is in the &#x60;Bearer {token}&#x60; format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).  | [optional]
@@ -489,11 +494,12 @@ Name | Type | Description  | Notes
  **zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  | [optional]
  **page** | **Number**| The index number of the page that you want to retrieve. This parameter is dependent on &#x60;pageSize&#x60;. You must set &#x60;pageSize&#x60; before specifying &#x60;page&#x60;. For example, if you set &#x60;pageSize&#x60; to &#x60;20&#x60; and &#x60;page&#x60; to &#x60;2&#x60;, the 21st to 40th records are returned in the response.  | [optional] [default to 1]
  **page_size** | **Number**| The number of records returned per page in the response.  | [optional] [default to 20]
- **owner_type** | **String**|  Possible values are: * invoiceOwner * subscriptionOwner  | [optional]
- **get_detailed_metrics** | **Boolean**|  If the &#x60;getDetailedMetrics&#x60; is &#x60;true&#x60;, &#x60;contractedNetMrr&#x60;, &#x60;asOfDayGrossMrr&#x60;, &#x60;asOfDayNetMrr&#x60; will be in the response. The default value is &#x60;false&#x60;.  | [optional]
- **as_of_day** | **String**|  The date for detailed metrics. Only available when &#x60;getDetailedMetrics&#x60; is &#x60;true&#x60;. The date should be in the format &#x60;YYYY-MM-DD&#x60;. The default value is the current date.  | [optional]
+ **owner_type** | **String**|  Possible values are: * invoiceOwner * subscriptionOwner | [optional]
+ **get_detailed_metrics** | **Boolean**|  If the &#x60;getDetailedMetrics&#x60; is &#x60;true&#x60;, &#x60;contractedNetMrr&#x60;, &#x60;asOfDayGrossMrr&#x60;, &#x60;asOfDayNetMrr&#x60; will be in the response. The default value is &#x60;false&#x60;. | [optional]
+ **as_of_day** | **String**|  The date for detailed metrics. Only available when &#x60;getDetailedMetrics&#x60; is &#x60;true&#x60;. The date should be in the format &#x60;YYYY-MM-DD&#x60;. The default value is the current date. | [optional]
  **charge_detail** | **String**| The segmented rate plan charges.  When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges.  Possible values are:  * __last-segment__: (Default) The last rate plan charge on the subscription. The last rate plan charge is the last one in the order of time on the subscription rather than the most recent changed charge on the subscription.  * __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate &lt;&#x3D; today’s date &lt; effectiveEndDate).    * __all-segments__: All the segmented charges. The &#x60;chargeSegments&#x60; field is returned in the response. The &#x60;chargeSegments&#x60; field contains an array of the charge information for all the charge segments.   * __specific-segment&amp;as-of-date&#x3D;date__: The segmented charge that is active on a date you specified (effectiveStartDate &lt;&#x3D; specific date &lt; effectiveEndDate). The format of the date is yyyy-mm-dd.  | [optional]
- **exclude_rate_plans_with_no_charges** | **Boolean**| If the &#x60;exclude-rate-plans-with-no-charges&#x60; is &#x60;true&#x60;, only the active charges and rate plans will be in the response. The default value is &#x60;false&#x60;.  | [optional]
+ **as_of_date** | **String**|  The date for charge-detail. Only available when &#x60;charge-detail&#x60; is &#x60;specific-segment&#x60;. The date should be in the format &#x60;YYYY-MM-DD&#x60;. | [optional]
+ **exclude_rate_plans_with_no_charges** | **Boolean**| If the &#x60;exclude-rate-plans-with-no-charges&#x60; is &#x60;true&#x60;, only the active charges and rate plans will be in the response. The default value is &#x60;false&#x60;. | [optional]
  **zuora_version** | **String**| The minor version of the Zuora REST API.   | [optional] [default to &#39;2024-05-20&#39;]
  **zuora_org_ids** | **String**| Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user&#39;s accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user&#39;s accessible orgs.  | [optional]
@@ -583,7 +589,7 @@ Name | Type | Description  | Notes
 Preview a subscription
-The REST API reference describes how to create a new subscription in preview mode. This call does not require a valid customer account. It can be used to show potential new customers a preview of a subscription with complete details and charges before creating an account, or to let existing customers preview a subscription with all charges before committing.  ### Notes - The response of the Preview Subscription call is based on the REST API minor version you set in the request header. The response structure might be different if you use different minor version numbers.   - If you have the Invoice Settlement feature enabled, we recommend that you set the &#x60;zuora-version&#x60; parameter to &#x60;207.0&#x60; or later. Otherwise, an error is returned.   - Default values for **customerAcceptanceDate** and **serviceActivationDate** are set as follows.  |        | serviceActivationDate (SA) specified          | serviceActivationDate (SA) NOT specified  | | ------------- |:-------------:| -----:| | customerAcceptanceDate (CA) specified      | SA uses value in the request call; CA uses value in the request call| CA uses value in the request call;SA uses CE as default | | customerAcceptanceDate (CA) NOT specified      | SA uses value in the request call; CA uses SA as default |   SA and CA use CE as default |
+The REST API reference describes how to create a new subscription in preview mode. This call does not require a valid customer account. It can be used to show potential new customers a preview of a subscription with complete details and charges before creating an account, or to let existing customers preview a subscription with all charges before committing.  ### Notes - The response of the Preview Subscription call is based on the REST API minor version you set in the request header. The response structure might be different if you use different minor version numbers.   - If you have the Invoice Settlement feature enabled, we recommend that you set the &#x60;zuora-version&#x60; parameter to &#x60;207.0&#x60; or later. Otherwise, an error is returned.   - Default values for **customerAcceptanceDate** and **serviceActivationDate** are set as follows. n|        | serviceActivationDate (SA) specified          | serviceActivationDate (SA) NOT specified  | | ------------- |:-------------:| -----:| | customerAcceptanceDate (CA) specified      | SA uses value in the request call; CA uses value in the request call| CA uses value in the request call;SA uses CE as default | | customerAcceptanceDate (CA) NOT specified      | SA uses value in the request call; CA uses SA as default |   SA and CA use CE as default |
 ### Example
@@ -649,7 +655,7 @@ Name | Type | Description  | Notes
 Renew a subscription
-Renews a termed subscription using existing renewal terms.  When you renew a subscription, the current subscription term is extended by creating a new term.   If any charge in your subscription has the billing period set as &#x60;SubscriptionTerm&#x60;， a new charge segment is generated for the new term.   **Note**: If you have the Invoice Settlement feature enabled, it is best practice to set the &#x60;zuora-version&#x60; parameter to &#x60;211.0&#x60; or later. Otherwise, an error occurs.
+Renews a termed subscription using existing renewal terms.  When you renew a subscription, the current subscription term is extended by creating a new term.   If any charge in your subscription has the billing period set as &#x60;SubscriptionTerm&#x60;， a new charge segment is generated for the new term. n **Note**: If you have the Invoice Settlement feature enabled, it is best practice to set the &#x60;zuora-version&#x60; parameter to &#x60;211.0&#x60; or later. Otherwise, an error occurs.
 ### Example