zuora-sdk-js 3.13.0 → 3.14.0-beta.2

package/docs/OrderActionUpdateProduct.md

@@ -5,6 +5,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **charge_updates** | [**[ChargeUpdate]**](ChargeUpdate.md) | Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action.  | [optional] 
+**charge_removals** | [**[ChargeRemoval]**](ChargeRemoval.md) | Array of the JSON objects containing the information for a charge removal in the `updateProduct` type of order action. Each item specifies a charge to be removed from the bundle rate plan.  **Note:** This field requires the EnableHardBundle permission to be enabled.  | [optional] 
+**charge_overrides** | [**[ChargeOverride]**](ChargeOverride.md) | Array of charge overrides for the UpdateProduct order action. Each item specifies a charge to be added or modified in the rate plan.  **Note:** This field requires the EnableHardBundle permission to be enabled. | [optional] 
 **clearing_existing_features** | **Boolean** | Specifies whether all features in the rate plan will be cleared.  | [optional] 
 **custom_fields** | **{String: Object}** | Container for custom fields of the Rate Plan object. The custom fields of the Rate Plan object are used when rate plans are subscribed.  | [optional] 
 **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] 

package/docs/PaymentGatewaysResponse.md

@@ -4,7 +4,10 @@
 
 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] [default to true]
 **paymentgateways** | [**[PaymentGatwayResponse]**](PaymentGatwayResponse.md) |  | [optional] 
-**success** | **Boolean** | Returns `true` if the request was processed successfully. | [optional] 
 
 

package/docs/PaymentMethodUpdaterInstancesResponse.md

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

package/docs/PaymentRun.md

@@ -26,6 +26,7 @@ Name | Type | Description | Notes
 **payment_gateway_number** | **String** |  | [optional] 
 **status** | [**PaymentRunStatus**](PaymentRunStatus.md) |  | [optional] 
 **target_date** | **String** | The target date used to determine which receivables to be collected in the payment run.   | [optional] 
+**advanced_filter** | **String** | The advanced filter used to select invoices when `useCustomPaymentMethods` is enabled.  This field is only returned when `useCustomPaymentMethods` is set to `true`.  | [optional] 
 **updated_by_id** | **String** | The ID of the Zuora user who last updated the payment run.  | [optional] 
 **updated_date** | **String** | The date and time when the payment run was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.  | [optional] 
 **organization_labels** | [**[OrganizationLabel]**](OrganizationLabel.md) | The organization(s) that the payment run is created for.  For each item in the array, either the `organizationId` or the `organizationName` field is required.  This field is only required when you have already turned on Multi-Org feature.  | [optional] 

package/docs/PaymentRunResponse.md

@@ -26,6 +26,7 @@ Name | Type | Description | Notes
 **payment_gateway_number** | **String** |  | [optional] 
 **status** | [**PaymentRunStatus**](PaymentRunStatus.md) |  | [optional] 
 **target_date** | **String** | The target date used to determine which receivables to be collected in the payment run.   | [optional] 
+**advanced_filter** | **String** | The advanced filter used to select invoices when `useCustomPaymentMethods` is enabled.  This field is only returned when `useCustomPaymentMethods` is set to `true`.  | [optional] 
 **updated_by_id** | **String** | The ID of the Zuora user who last updated the payment run.  | [optional] 
 **updated_date** | **String** | The date and time when the payment run was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.  | [optional] 
 **organization_labels** | [**[OrganizationLabel]**](OrganizationLabel.md) | The organization(s) that the payment run is created for.  For each item in the array, either the `organizationId` or the `organizationName` field is required.  This field is only required when you have already turned on Multi-Org feature.  | [optional] 

package/docs/PaymentSchedulesApi.md

@@ -9,6 +9,8 @@ Method | HTTP request | Description
 [**cancelPaymentScheduleItem**](PaymentSchedulesApi.md#cancelPaymentScheduleItem) | **PUT** /v1/payment-schedule-items/{item-id}/cancel | Cancel a payment schedule item
 [**createPaymentSchedule**](PaymentSchedulesApi.md#createPaymentSchedule) | **POST** /v1/payment-schedules | Create a payment schedule
 [**createPaymentSchedules**](PaymentSchedulesApi.md#createPaymentSchedules) | **POST** /v1/payment-schedules/batch | Create multiple payment schedules at once
+[**deletePaymentSchedule**](PaymentSchedulesApi.md#deletePaymentSchedule) | **DELETE** /v1/payment-schedules/{paymentScheduleKey} | Delete a payment schedule
+[**deletePaymentScheduleItem**](PaymentSchedulesApi.md#deletePaymentScheduleItem) | **DELETE** /v1/payment-schedule-items/{item-id} | Delete a payment schedule item
 [**getPaymentSchedule**](PaymentSchedulesApi.md#getPaymentSchedule) | **GET** /v1/payment-schedules/{paymentScheduleKey} | Retrieve a payment schedule
 [**getPaymentScheduleItem**](PaymentSchedulesApi.md#getPaymentScheduleItem) | **GET** /v1/payment-schedule-items/{item-id} | Retrieve a payment schedule item
 [**getPaymentScheduleStatistic**](PaymentSchedulesApi.md#getPaymentScheduleStatistic) | **GET** /v1/payment-schedules/statistics/{yyyy-mm-dd} | Retrieve payment schedule statistic of a date
@@ -351,6 +353,134 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## deletePaymentSchedule
+
+> CommonResponse deletePaymentSchedule(payment_schedule_key, opts)
+
+Delete a payment schedule
+
+Deletes a payment schedule by payment schedule key.  **Note:** - The Payment Schedules feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge Center. - This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. - You can only delete payment schedules that have no processed payment schedule items. 
+
+### Example
+
+```javascript
+import ZuoraSdkJs from 'zuora-sdk-js';
+let defaultClient = ZuoraSdkJs.ApiClient.instance;
+// Configure Bearer access token for authorization: bearerAuth
+let bearerAuth = defaultClient.authentications['bearerAuth'];
+bearerAuth.accessToken = "YOUR ACCESS TOKEN"
+
+let apiInstance = new ZuoraSdkJs.PaymentSchedulesApi();
+let payment_schedule_key = "payment_schedule_key_example"; // String | The unique ID or number of a payment schedule. For example, `8a90857b822459cd018224dcb9eb13be`, or `PS-00000007`.
+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. 
+  '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_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. 
+  'zuora_version': "zuora_version_example", // 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. 
+};
+apiInstance.deletePaymentSchedule(payment_schedule_key, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payment_schedule_key** | **String**| The unique ID or number of a payment schedule. For example, `8a90857b822459cd018224dcb9eb13be`, or `PS-00000007`. | 
+ **accept_encoding** | **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.  | [optional] 
+ **content_encoding** | **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.  | [optional] 
+ **authorization** | **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).  | [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 (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).  | [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_version** | **String**| The minor version of the Zuora REST API.   | [optional] 
+ **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'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.  | [optional] 
+
+### Return type
+
+[**CommonResponse**](CommonResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## deletePaymentScheduleItem
+
+> CommonResponse deletePaymentScheduleItem(item_id, opts)
+
+Delete a payment schedule item
+
+Deletes a payment schedule item by ID.  **Note:** - The Payment Schedules feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge Center. - This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. - You can only delete payment schedule items that are in `Pending` or `Error` status. 
+
+### Example
+
+```javascript
+import ZuoraSdkJs from 'zuora-sdk-js';
+let defaultClient = ZuoraSdkJs.ApiClient.instance;
+// Configure Bearer access token for authorization: bearerAuth
+let bearerAuth = defaultClient.authentications['bearerAuth'];
+bearerAuth.accessToken = "YOUR ACCESS TOKEN"
+
+let apiInstance = new ZuoraSdkJs.PaymentSchedulesApi();
+let item_id = "item_id_example"; // String | The unique ID of a payment schedule item.
+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. 
+  '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_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. 
+  'zuora_version': "zuora_version_example", // 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. 
+};
+apiInstance.deletePaymentScheduleItem(item_id, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **item_id** | **String**| The unique ID of a payment schedule item. | 
+ **accept_encoding** | **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.  | [optional] 
+ **content_encoding** | **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.  | [optional] 
+ **authorization** | **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).  | [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 (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).  | [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_version** | **String**| The minor version of the Zuora REST API.   | [optional] 
+ **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'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.  | [optional] 
+
+### Return type
+
+[**CommonResponse**](CommonResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## getPaymentSchedule
 
 > PaymentScheduleResponse getPaymentSchedule(payment_schedule_key, opts)

package/docs/PaymentsApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://rest.zuora.com*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**applyPayment**](PaymentsApi.md#applyPayment) | **PUT** /v1/payments/{paymentKey}/apply | Apply a payment
+[**bulkUpsertPaymentProfiles**](PaymentsApi.md#bulkUpsertPaymentProfiles) | **PUT** /v1/payment-profile | Bulk create or update payment profiles
 [**cancelPayment**](PaymentsApi.md#cancelPayment) | **PUT** /v1/payments/{paymentKey}/cancel | Cancel a payment
 [**createPayment**](PaymentsApi.md#createPayment) | **POST** /v1/payments | Create a payment
 [**createRefundPayment**](PaymentsApi.md#createRefundPayment) | **POST** /v1/payments/{paymentKey}/refunds | Refund a payment
@@ -88,6 +89,72 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## bulkUpsertPaymentProfiles
+
+> BulkPaymentProfileResponse bulkUpsertPaymentProfiles(request, opts)
+
+Bulk create or update payment profiles
+
+Bulk creates payment profiles or updates payment profiles if they already exist.  You can create or update a maximum of 50 payment profiles in a single call. 
+
+### Example
+
+```javascript
+import ZuoraSdkJs from 'zuora-sdk-js';
+let defaultClient = ZuoraSdkJs.ApiClient.instance;
+// Configure Bearer access token for authorization: bearerAuth
+let bearerAuth = defaultClient.authentications['bearerAuth'];
+bearerAuth.accessToken = "YOUR ACCESS TOKEN"
+
+let apiInstance = new ZuoraSdkJs.PaymentsApi();
+let request = {"bulkPaymentOptionItems":[{"subscriptionId":"8ad080f08ed1c780018ed6acc5eb65fd","paymentGatewayId":"8b48f15831445266784be9fb20be9b40","paymentMethodId":"8ad09be48e5bcc3f018e5f0c0791674d"},{"subscriptionId":"2c92c0f86a8dd422016a9e7a70116b0d","paymentGatewayId":"8ad086dc88762fc7018876e2a83406ef","paymentMethodId":"8ad0950c8292b8560182a75940b808cd"}]}; // BulkPaymentProfileRequest | 
+let opts = {
+  'idempotency_key': "idempotency_key_example", // String | Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.   With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.  
+  '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. 
+  '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 (`'`). 
+  'zuora_version': "zuora_version_example", // 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. 
+};
+apiInstance.bulkUpsertPaymentProfiles(request, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**BulkPaymentProfileRequest**](BulkPaymentProfileRequest.md)|  | 
+ **idempotency_key** | **String**| Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.   With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.   | [optional] 
+ **accept_encoding** | **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.  | [optional] 
+ **content_encoding** | **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.  | [optional] 
+ **authorization** | **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).  | [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 (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).  | [optional] 
+ **zuora_version** | **String**| The minor version of the Zuora REST API.   | [optional] 
+ **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'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.  | [optional] 
+
+### Return type
+
+[**BulkPaymentProfileResponse**](BulkPaymentProfileResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## cancelPayment
 
 > PaymentResponse cancelPayment(payment_key, opts)

package/docs/PeriodTypeEnum.md

@@ -13,4 +13,6 @@
 
 * `SpecificMonths` (value: `"SpecificMonths"`)
 
+* `SinglePeriod` (value: `"SinglePeriod"`)
+
 

package/docs/PreviewOrderRatePlanUpdate.md

@@ -5,6 +5,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **charge_updates** | [**[PreviewOrderChargeUpdate]**](PreviewOrderChargeUpdate.md) | Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action.   When previewing an `updateProduct` order action, either the `chargeNumber` or `uniqueToken` field is required to specify the charge to update. | [optional] 
+**charge_overrides** | [**[ChargeOverride]**](ChargeOverride.md) | Array of charge overrides for the UpdateProduct order action. Each item specifies a charge to be added or modified in the rate plan. | [optional] 
+**charge_removals** | [**[ChargeRemoval]**](ChargeRemoval.md) | Array of charge removals for the UpdateProduct order action. Each item specifies a charge to be removed from the bundle rate plan.  **Note:** This field requires the EnableHardBundle permission to be enabled.  | [optional] 
 **clearing_existing_features** | **Boolean** | Specifies whether all features in the rate plan will be cleared.  | [optional] 
 **custom_fields** | **{String: Object}** | Container for custom fields of the Rate Plan object. The custom fields of  the Rate Plan object are used when rate plans are subscribed. | [optional] 
 **product_rate_plan_number** | **String** | Number of a product rate plan for this subscription.  | [optional] 

package/docs/PreviewSubscriptionResponse.md

@@ -4,6 +4,10 @@
 
 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] [default to true]
 **amount** | **Number** | Invoice amount. 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] 
 **amount_without_tax** | **Number** | Invoice amount minus tax. 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] 
@@ -13,7 +17,6 @@ Name | Type | Description | Notes
 **invoice** | [**PreviewSubscriptionInvoice**](PreviewSubscriptionInvoice.md) |  | [optional] 
 **invoice_items** | [**[PreviewSubscriptionInvoiceItem]**](PreviewSubscriptionInvoiceItem.md) | Container for invoice items. 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] 
 **invoice_target_date** | **String** | Date through which charges are calculated on the invoice, as yyyy-mm-dd.   **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, 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] 
-**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] 
 **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_contracted_value** | **Number** | Total contracted value of the subscription.  | [optional] 

package/docs/PutRevproAccCodeResponse.md

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

package/docs/QueryCommitmentAssociatedAccountsResponse.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.QueryCommitmentAssociatedAccountsResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**next_page** | **String** |  | [optional] 
+**data** | [**[ExpandedCommitmentAssociatedAccount]**](ExpandedCommitmentAssociatedAccount.md) |  | [optional] 
+
+

package/docs/QueryCommitmentAssociatedItemsResponse.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.QueryCommitmentAssociatedItemsResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**next_page** | **String** |  | [optional] 
+**data** | [**[ExpandedCommitmentAssociatedItem]**](ExpandedCommitmentAssociatedItem.md) |  | [optional] 
+
+

package/docs/QueryCommitmentSchedulesResponse.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.QueryCommitmentSchedulesResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**next_page** | **String** |  | [optional] 
+**data** | [**[ExpandedCommitmentSchedule]**](ExpandedCommitmentSchedule.md) |  | [optional] 
+
+

package/docs/QueryCommitmentTransactionsResponse.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.QueryCommitmentTransactionsResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**next_page** | **String** |  | [optional] 
+**data** | [**[ExpandedCommitmentTransaction]**](ExpandedCommitmentTransaction.md) |  | [optional] 
+
+

package/docs/RSASignatureResponse.md

@@ -4,9 +4,12 @@
 
 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] [default to true]
 **key** | **String** | Public key generated for this Payment Page.  | [optional] 
 **signature** | **String** | Digital signature generated for this Payment Page.   If `signature` returns `null` but `token` is successfully returned, please limit the number of the fields in your request to make sure that the maximum length supported by the RSA signature algorithm is not exceeded. | [optional] 
-**success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
 **tenant_id** | **String** | ID of the Zuora tenant.  | [optional] 
 **token** | **String** | Token generated for this Payment Page.  | [optional] 
 

package/docs/RatePlanChargeSegment.md

@@ -77,6 +77,9 @@ Name | Type | Description | Notes
 **pricing_attributes** | **{String: Object}** | Container for pricing attributes used in dynamic pricing.  **Note**: This field is only available when DynamicPricing permission enabled.  | [optional] 
 **is_dimensional_price** | **Boolean** | Indicates whether the charge uses dimensional pricing.  **Note**: This field is only available when DynamicPricing permission enabled.  | [optional] 
 **is_price_negotiated** | **Boolean** | Indicates whether the charge uses negotiated pricing.  **Note**: This field is only available when NegotiatedPriceTable permission enabled.  | [optional] 
+**is_last_segment** | **Boolean** | Indicates whether the charge segment is the last segment.  | [optional] 
+**optional** | **Boolean** | Indicates whether this charge is optional in a bundle rate plan. Optional charges can be added to or removed from subscriptions using the UpdateProduct order action.  **Note:** This field is only available when EnableHardBundle permission enabled.  | [optional] 
+**status** | **String** | The status of the charge. Possible values: - `removeDirectly`: The charge has been removed via UpdateProduct order action. - `deleteWithRatePlan`: The charge has been deleted with the rate plan.  **Note:** This field is only available when EnableHardBundle permission enabled.  | [optional] 
 
 
 
@@ -114,3 +117,14 @@ Name | Type | Description | Notes
 
 
 
+
+## Enum: StatusEnum
+
+
+* `removeDirectly` (value: `"removeDirectly"`)
+
+* `deleteWithRatePlan` (value: `"deleteWithRatePlan"`)
+
+
+
+

package/docs/RatePlanChargeSegmentInfo.md

@@ -77,6 +77,9 @@ Name | Type | Description | Notes
 **pricing_attributes** | **{String: Object}** | Container for pricing attributes used in dynamic pricing.  **Note**: This field is only available when DynamicPricing permission enabled.  | [optional] 
 **is_dimensional_price** | **Boolean** | Indicates whether the charge uses dimensional pricing.  **Note**: This field is only available when DynamicPricing permission enabled.  | [optional] 
 **is_price_negotiated** | **Boolean** | Indicates whether the charge uses negotiated pricing.  **Note**: This field is only available when NegotiatedPriceTable permission enabled.  | [optional] 
+**is_last_segment** | **Boolean** | Indicates whether the charge segment is the last segment.  | [optional] 
+**optional** | **Boolean** | Indicates whether this charge is optional in a bundle rate plan. Optional charges can be added to or removed from subscriptions using the UpdateProduct order action.  **Note:** This field is only available when EnableHardBundle permission enabled.  | [optional] 
+**status** | **String** | The status of the charge. Possible values: - `removeDirectly`: The charge has been removed via UpdateProduct order action. - `deleteWithRatePlan`: The charge has been deleted with the rate plan.  **Note:** This field is only available when EnableHardBundle permission enabled.  | [optional] 
 
 
 
@@ -114,3 +117,14 @@ Name | Type | Description | Notes
 
 
 
+
+## Enum: StatusEnum
+
+
+* `removeDirectly` (value: `"removeDirectly"`)
+
+* `deleteWithRatePlan` (value: `"deleteWithRatePlan"`)
+
+
+
+

package/docs/RatePlanUpdate.md

@@ -5,6 +5,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **charge_updates** | [**[ChargeUpdate]**](ChargeUpdate.md) | Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action.  | [optional] 
+**charge_removals** | [**[ChargeRemoval]**](ChargeRemoval.md) | Array of the JSON objects containing the information for a charge removal in the `updateProduct` type of order action. Each item specifies a charge to be removed from the bundle rate plan.  **Note:** This field requires the EnableHardBundle permission to be enabled.  | [optional] 
+**charge_overrides** | [**[ChargeOverride]**](ChargeOverride.md) | Array of charge overrides for the UpdateProduct order action. Each item specifies a charge to be added or modified in the rate plan.  **Note:** This field requires the EnableHardBundle permission to be enabled. | [optional] 
 **clearing_existing_features** | **Boolean** | Specifies whether all features in the rate plan will be cleared.  | [optional] 
 **custom_fields** | **{String: Object}** | Container for custom fields of the Rate Plan object. The custom fields of the Rate Plan object are used when rate plans are subscribed.  | [optional] 
 **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] 

package/docs/RegenerateRevRecEventsResponse.md

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

package/docs/RegenerateTransactionObjectResponse.md

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

package/docs/RenewSubscriptionResponse.md

@@ -4,12 +4,15 @@
 
 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] [default to true]
 **subscription_id** | **String** | Subscription ID, It is available for Orders Harmonization and Subscribe/Amend tenants.  | [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_id** | **String** | Invoice ID, if one is generated.  | [optional] 
 **paid_amount** | **Number** | Payment amount, if payment is collected.  | [optional] 
 **payment_id** | **String** | Payment ID, if payment is collected.  | [optional] 
-**success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
 **term_end_date** | **String** | Date the new subscription term ends, as yyyy-mm-dd. It is available for Orders Harmonization and Subscribe/Amend tenants.  | [optional] 
 **term_start_date** | **String** | Date the new subscription term begins, as yyyy-mm-dd. It is available for Orders Harmonization and Subscribe/Amend tenants.  | [optional] 
 **total_delta_mrr** | **Number** | Change in the subscription monthly recurring revenue as a result of the update. For a renewal, this is the MRR of the subscription in the new term. It is available for Orders Harmonization and Subscribe/Amend tenants. | [optional] 

package/docs/ResumeSubscriptionResponse.md

@@ -4,13 +4,16 @@
 
 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] [default to true]
 **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_id** | **String** | Invoice ID, if an invoice is generated during the subscription process.  | [optional] 
 **paid_amount** | **Number** | Payment amount, if a payment is collected.  | [optional] 
 **payment_id** | **String** | Payment ID, if a payment is collected.  | [optional] 
 **resume_date** | **String** | The date when subscription resumption takes effect, as yyyy-mm-dd. It is available for Orders Harmonization and Subscribe/Amend tenants.  | [optional] 
 **subscription_id** | **String** | The subscription ID. It is available for Orders Harmonization and Subscribe/Amend tenants.  | [optional] 
-**success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
 **term_end_date** | **String** | The date when the new subscription term ends, as yyyy-mm-dd. It is available for Orders Harmonization and Subscribe/Amend tenants.  | [optional] 
 **total_delta_tcv** | **Number** | Change in the total contracted value of the subscription as a result of the update. It is available for Orders Harmonization and Subscribe/Amend tenants. | [optional] 
 **order_number** | **String** | The order number. It is available for Orders Tenants.  | [optional] 

package/docs/RetryPaymentScheduleItemResponse.md

@@ -4,7 +4,10 @@
 
 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] [default to true]
 **items** | [**[PaymentScheduleItem]**](PaymentScheduleItem.md) |  | [optional] 
-**success** | **Boolean** | Returns `true` if the request was processed successfully.   | [optional] 
 
 

package/docs/StoredCredentialProfilesResponse.md

@@ -4,7 +4,10 @@
 
 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] [default to true]
 **profiles** | [**[StoredCredentialProfileResponse]**](StoredCredentialProfileResponse.md) | Container for stored credential profiles.  | [optional] 
-**success** | **Boolean** |  | [optional] 
 
 

package/docs/SubmitDataLabelingJobResponse.md

@@ -4,9 +4,12 @@
 
 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] [default to true]
 **job_id** | **String** | Identifier of the data labeling job.  | [optional] 
 **job_status** | **String** | Status of the data labeling job.   * `Accepted` - The data labeling job has been accepted by the system.  * `Dispatched` - The data labeling job is dispatched to the data labeling service.  * `Completed` - The data labeling job has completed. Please note that `Completed` 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 `progress` field to see how many data have been `labeled`, `failed` or `timeout`. | [optional] 
-**success** | **Boolean** | Indicates whether the job was submitted successfully.  | [optional] 
 
 
 

package/docs/SubscriptionRatePlan.md

@@ -13,6 +13,7 @@ Name | Type | Description | Notes
 **product_sku** | **String** | The unique SKU for the product. | [optional] 
 **product_rate_plan_id** | **String** |  | [optional] 
 **product_rate_plan_number** | **String** |  | [optional] 
+**product_rate_plan_type** | **String** | The type of the product rate plan (e.g., Standalone, RatePlanHardBundle). | [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] 
@@ -21,6 +22,7 @@ Name | Type | Description | Notes
 **as_of_day_gross_mrr** | **Number** | Monthly recurring revenue of the subscription rate plan exclusive of any discounts applicable as of specified day.  | [optional] 
 **as_of_day_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 as of specified day.  | [optional] 
 **rate_plan_charges** | [**[GetSubscriptionRatePlanChargesWithAllSegments]**](GetSubscriptionRatePlanChargesWithAllSegments.md) | Container for one or more charges. | [optional] 
+**original_rate_plan_id** | **String** | The original rate plan id. | [optional]