zuora-sdk-js 3.6.0 → 3.7.0

package/docs/RefundsApi.md

@@ -98,7 +98,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.RefundsApi();
-let refund_key = "refund_key_example"; // String | The unique ID of a refund or the refund number. For example, 4028905f5a87c0ff015a889e590e00c9. 
+let refund_key = "refund_key_example"; // String | The unique ID of a refund or the refund number. For example, 4028905f5a87c0ff015a889e590e00c9.
 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. 
@@ -121,7 +121,7 @@ apiInstance.deleteRefund(refund_key, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **refund_key** | **String**| The unique ID of a refund or the refund number. For example, 4028905f5a87c0ff015a889e590e00c9.  | 
+ **refund_key** | **String**| The unique ID of a refund or the refund number. For example, 4028905f5a87c0ff015a889e590e00c9. | 
  **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] 
@@ -162,7 +162,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.RefundsApi();
-let refund_key = "refund_key_example"; // String | The unique ID of a refund or the refund number. For example, 4028905f5a87c0ff015a889e590e00c9. 
+let refund_key = "refund_key_example"; // String | The unique ID of a refund or the refund number. For example, 4028905f5a87c0ff015a889e590e00c9.
 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. 
@@ -185,7 +185,7 @@ apiInstance.getRefund(refund_key, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **refund_key** | **String**| The unique ID of a refund or the refund number. For example, 4028905f5a87c0ff015a889e590e00c9.  | 
+ **refund_key** | **String**| The unique ID of a refund or the refund number. For example, 4028905f5a87c0ff015a889e590e00c9. | 
  **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] 
@@ -226,9 +226,9 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.RefundsApi();
-let item_part_id = "item_part_id_example"; // String | The unique ID of a specific refund part item. You can get the refund part item ID from the response of [Get refund part items](https://www.zuora.com/developer/api-references/api/operation/Get_RefundItemParts). 
-let refund_part_id = "refund_part_id_example"; // String | The unique ID of a specific refund part. You can get the refund part ID from the response of [List all parts of a refund](https://www.zuora.com/developer/api-references/api/operation/Get_RefundParts). 
-let refund_key = "refund_key_example"; // String | The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9. 
+let item_part_id = "item_part_id_example"; // String | The unique ID of a specific refund part item. You can get the refund part item ID from the response of [Get refund part items](https://www.zuora.com/developer/api-references/api/operation/Get_RefundItemParts).
+let refund_part_id = "refund_part_id_example"; // String | The unique ID of a specific refund part. You can get the refund part ID from the response of [List all parts of a refund](https://www.zuora.com/developer/api-references/api/operation/Get_RefundParts).
+let refund_key = "refund_key_example"; // String | The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.
 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. 
@@ -251,9 +251,9 @@ apiInstance.getRefundItemPart(item_part_id, refund_part_id, refund_key, opts).th
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **item_part_id** | **String**| The unique ID of a specific refund part item. You can get the refund part item ID from the response of [Get refund part items](https://www.zuora.com/developer/api-references/api/operation/Get_RefundItemParts).  | 
- **refund_part_id** | **String**| The unique ID of a specific refund part. You can get the refund part ID from the response of [List all parts of a refund](https://www.zuora.com/developer/api-references/api/operation/Get_RefundParts).  | 
- **refund_key** | **String**| The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.  | 
+ **item_part_id** | **String**| The unique ID of a specific refund part item. You can get the refund part item ID from the response of [Get refund part items](https://www.zuora.com/developer/api-references/api/operation/Get_RefundItemParts). | 
+ **refund_part_id** | **String**| The unique ID of a specific refund part. You can get the refund part ID from the response of [List all parts of a refund](https://www.zuora.com/developer/api-references/api/operation/Get_RefundParts). | 
+ **refund_key** | **String**| The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9. | 
  **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] 
@@ -294,8 +294,8 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.RefundsApi();
-let refund_part_id = "refund_part_id_example"; // String | The unique ID of a specific refund part. You can get the refund part ID from the response of [List all parts of a refund](https://www.zuora.com/developer/api-references/api/operation/Get_RefundParts). 
-let refund_key = "refund_key_example"; // String | The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9. 
+let refund_part_id = "refund_part_id_example"; // String | The unique ID of a specific refund part. You can get the refund part ID from the response of [List all parts of a refund](https://www.zuora.com/developer/api-references/api/operation/Get_RefundParts).
+let refund_key = "refund_key_example"; // String | The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.
 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. 
@@ -320,8 +320,8 @@ apiInstance.getRefundItemParts(refund_part_id, refund_key, opts).then((data) =>
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **refund_part_id** | **String**| The unique ID of a specific refund part. You can get the refund part ID from the response of [List all parts of a refund](https://www.zuora.com/developer/api-references/api/operation/Get_RefundParts).  | 
- **refund_key** | **String**| The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.  | 
+ **refund_part_id** | **String**| The unique ID of a specific refund part. You can get the refund part ID from the response of [List all parts of a refund](https://www.zuora.com/developer/api-references/api/operation/Get_RefundParts). | 
+ **refund_key** | **String**| The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9. | 
  **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] 
@@ -364,8 +364,8 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.RefundsApi();
-let refund_part_id = "refund_part_id_example"; // String | The unique ID of a specific refund part. You can get the refund part ID from the response of [List all parts of a refund](https://www.zuora.com/developer/api-references/api/operation/Get_RefundParts). 
-let refund_key = "refund_key_example"; // String | The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9. 
+let refund_part_id = "refund_part_id_example"; // String | The unique ID of a specific refund part. You can get the refund part ID from the response of [List all parts of a refund](https://www.zuora.com/developer/api-references/api/operation/Get_RefundParts).
+let refund_key = "refund_key_example"; // String | The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.
 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. 
@@ -388,8 +388,8 @@ apiInstance.getRefundPart(refund_part_id, refund_key, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **refund_part_id** | **String**| The unique ID of a specific refund part. You can get the refund part ID from the response of [List all parts of a refund](https://www.zuora.com/developer/api-references/api/operation/Get_RefundParts).  | 
- **refund_key** | **String**| The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.  | 
+ **refund_part_id** | **String**| The unique ID of a specific refund part. You can get the refund part ID from the response of [List all parts of a refund](https://www.zuora.com/developer/api-references/api/operation/Get_RefundParts). | 
+ **refund_key** | **String**| The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9. | 
  **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] 
@@ -430,7 +430,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.RefundsApi();
-let refund_key = "refund_key_example"; // String | The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9. 
+let refund_key = "refund_key_example"; // String | The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.
 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. 
@@ -453,7 +453,7 @@ apiInstance.getRefundParts(refund_key, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **refund_key** | **String**| The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.  | 
+ **refund_key** | **String**| The number or unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9. | 
  **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] 
@@ -482,7 +482,7 @@ Name | Type | Description  | Notes
 
 List refunds
 
-**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.   Retrieves the information about all refunds. Two types of refunds are available, electronic refunds and external refunds.  ### Filtering  You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body.  If the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`.  Examples:  - /v1/refunds?status=Processed  - /v1/refunds?amount=4&status=Processed  - /v1/refunds?status=Processed&type=External&sort=+number 
+**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.   Retrieves the information about all refunds. Two types of refunds are available, electronic refunds and external refunds.  ### Filtering nYou can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body.  If the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`.  Examples:  - /v1/refunds?status=Processed  - /v1/refunds?amount=4&status=Processed n- /v1/refunds?status=Processed&type=External&sort=+number 
 
 ### Example
 
@@ -502,18 +502,18 @@ 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. 
-  'account_id': "account_id_example", // String | This parameter filters the response based on the `accountId` field. 
-  'amount': 3.4, // Number | This parameter filters the response based on the `amount` field. 
-  'created_by_id': "created_by_id_example", // String | This parameter filters the response based on the `createdById` field. 
-  'created_date': new Date("2013-10-20T19:20:30+01:00"), // Date | This parameter filters the response based on the `createdDate` field. 
-  'method_type': "method_type_example", // PaymentMethodType | This parameter filters the response based on the `methodType` field. 
-  'number': "number_example", // String | This parameter filters the response based on the `number` field. 
-  'payment_id': "payment_id_example", // String | This parameter filters the response based on the `paymentId` field. 
-  'refund_date': new Date("2013-10-20"), // String | This parameter filters the response based on the `refundDate` field. 
-  'status': "status_example", // String | This parameter filters the response based on the `status` field. 
-  'type': "type_example", // String | This parameter filters the response based on the `type` field. 
-  'updated_by_id': "updated_by_id_example", // String | This parameter filters the response based on the `updatedById` field. 
-  'updated_date': new Date("2013-10-20T19:20:30+01:00"), // Date | This parameter filters the response based on the `updatedDate` field. 
+  'account_id': "account_id_example", // String | This parameter filters the response based on the `accountId` field.
+  'amount': 3.4, // Number | This parameter filters the response based on the `amount` field.
+  'created_by_id': "created_by_id_example", // String | This parameter filters the response based on the `createdById` field.
+  'created_date': new Date("2013-10-20T19:20:30+01:00"), // Date | This parameter filters the response based on the `createdDate` field.
+  'method_type': "method_type_example", // PaymentMethodType | This parameter filters the response based on the `methodType` field.
+  'number': "number_example", // String | This parameter filters the response based on the `number` field.
+  'payment_id': "payment_id_example", // String | This parameter filters the response based on the `paymentId` field.
+  'refund_date': new Date("2013-10-20"), // String | This parameter filters the response based on the `refundDate` field.
+  'status': "status_example", // String | This parameter filters the response based on the `status` field.
+  'type': "type_example", // String | This parameter filters the response based on the `type` field.
+  'updated_by_id': "updated_by_id_example", // String | This parameter filters the response based on the `updatedById` field.
+  'updated_date': new Date("2013-10-20T19:20:30+01:00"), // Date | This parameter filters the response based on the `updatedDate` field.
   'sort': "sort_example", // String | This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.  A sortable field uses the following form:   *operator* *field_name*  You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example:  *operator* *field_name*, *operator* *field_name*    *operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.    - The `-` operator indicates an ascending order.   - The `+` operator indicates a descending order.  By default, the response data is displayed in descending order by refund number.  *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:    - number   - accountId   - amount   - refundDate   - paymentId   - createdDate   - createdById   - updatedDate   - updatedById    Examples:  - /v1/refunds?sort=+number  - /v1/refunds?status=Processed&sort=-number,+amount 
   '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. 
@@ -538,18 +538,18 @@ 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 `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.  | [optional] [default to 1]
  **page_size** | **Number**| The number of records returned per page in the response.  | [optional] [default to 20]
- **account_id** | **String**| This parameter filters the response based on the `accountId` field.  | [optional] 
- **amount** | **Number**| This parameter filters the response based on the `amount` field.  | [optional] 
- **created_by_id** | **String**| This parameter filters the response based on the `createdById` field.  | [optional] 
- **created_date** | **Date**| This parameter filters the response based on the `createdDate` field.  | [optional] 
- **method_type** | **PaymentMethodType**| This parameter filters the response based on the `methodType` field.  | [optional] 
- **number** | **String**| This parameter filters the response based on the `number` field.  | [optional] 
- **payment_id** | **String**| This parameter filters the response based on the `paymentId` field.  | [optional] 
- **refund_date** | **String**| This parameter filters the response based on the `refundDate` field.  | [optional] 
- **status** | **String**| This parameter filters the response based on the `status` field.  | [optional] 
- **type** | **String**| This parameter filters the response based on the `type` field.  | [optional] 
- **updated_by_id** | **String**| This parameter filters the response based on the `updatedById` field.  | [optional] 
- **updated_date** | **Date**| This parameter filters the response based on the `updatedDate` field.  | [optional] 
+ **account_id** | **String**| This parameter filters the response based on the `accountId` field. | [optional] 
+ **amount** | **Number**| This parameter filters the response based on the `amount` field. | [optional] 
+ **created_by_id** | **String**| This parameter filters the response based on the `createdById` field. | [optional] 
+ **created_date** | **Date**| This parameter filters the response based on the `createdDate` field. | [optional] 
+ **method_type** | **PaymentMethodType**| This parameter filters the response based on the `methodType` field. | [optional] 
+ **number** | **String**| This parameter filters the response based on the `number` field. | [optional] 
+ **payment_id** | **String**| This parameter filters the response based on the `paymentId` field. | [optional] 
+ **refund_date** | **String**| This parameter filters the response based on the `refundDate` field. | [optional] 
+ **status** | **String**| This parameter filters the response based on the `status` field. | [optional] 
+ **type** | **String**| This parameter filters the response based on the `type` field. | [optional] 
+ **updated_by_id** | **String**| This parameter filters the response based on the `updatedById` field. | [optional] 
+ **updated_date** | **Date**| This parameter filters the response based on the `updatedDate` field. | [optional] 
  **sort** | **String**| This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.  A sortable field uses the following form:   *operator* *field_name*  You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example:  *operator* *field_name*, *operator* *field_name*    *operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.    - The `-` operator indicates an ascending order.   - The `+` operator indicates a descending order.  By default, the response data is displayed in descending order by refund number.  *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:    - number   - accountId   - amount   - refundDate   - paymentId   - createdDate   - createdById   - updatedDate   - updatedById    Examples:  - /v1/refunds?sort=+number  - /v1/refunds?status=Processed&sort=-number,+amount  | [optional] 
  **zuora_version** | **String**| The minor version of the Zuora REST API.   | [optional] [default to '2024-05-20']
  **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] 
@@ -586,7 +586,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.RefundsApi();
-let refund_id = "refund_id_example"; // String | The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9. 
+let refund_id = "refund_id_example"; // String | The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.
 let body = new ZuoraSdkJs.UpdateRefundRequest(); // UpdateRefundRequest | 
 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. 
@@ -610,7 +610,7 @@ apiInstance.updateRefund(refund_id, body, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **refund_id** | **String**| The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.  | 
+ **refund_id** | **String**| The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9. | 
  **body** | [**UpdateRefundRequest**](UpdateRefundRequest.md)|  | 
  **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] 

package/docs/RejectPaymentRequest.md

@@ -6,10 +6,10 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **gateway_reconciliation_reason** | **String** | The reason of gateway reconciliation.  | [optional] 
 **gateway_reconciliation_status** | **String** | The status of gateway reconciliation.  | [optional] 
-**gateway_response** | **String** | The transaction response returned by the gateway for this transaction. If the transaction was declined, this reason is provided in the message.  | [optional] 
-**gateway_response_code** | **String** | Response message Code returned by the gateway about the transaction status.  | [optional] 
-**reference_id** | **String** | Unique Id generated by the gateway for each transaction. Use this ID to find the respective Zuora Payment ID.   | [optional] 
+**gateway_response** | **String** | The transaction response returned by the gateway for this transaction. If the transaction was declined, this reason is provided in the message. | [optional] 
+**gateway_response_code** | **String** | Response message Code returned by the gateway about the transaction status. | [optional] 
+**reference_id** | **String** | Unique Id generated by the gateway for each transaction. Use this ID to find the respective Zuora Payment ID.  | [optional] 
 **second_reference_id** | **String** | The second reference Id. Some gateway uses two unique transaction IDs.  | [optional] 
-**settled_on** | **String** | The date and time of the transaction settlement. The format is `yyyy-mm-dd hh:mm:ss`.  | [optional] 
+**settled_on** | **String** | The date and time of the transaction settlement. The format is `yyyy-mm-dd hh:mm:ss`. | [optional] 
 
 

package/docs/RemoveCatalogGroupProductRatePlan.md

@@ -4,6 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **String** | The unique ID of the product rate plan to be removed from the catalog group.  | [optional] 
+**id** | **String** | The unique ID of the product rate plan to be removed from the catalog group. | [optional] 
 
 

package/docs/RemoveSubscriptionRatePlan.md

@@ -4,14 +4,14 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**booking_date** | **String** | The booking date that you want to set for the amendment contract. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the `yyyy-mm-dd` format. The default value is the current date when you make the API call.   | [optional] 
+**booking_date** | **String** | The booking date that you want to set for the amendment contract. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the `yyyy-mm-dd` format. The default value is the current date when you make the API call.  | [optional] 
 **contract_effective_date** | **String** | Effective date of the new subscription, as yyyy-mm-dd.  | 
-**customer_acceptance_date** | **String** | The date when the customer accepts the contract in yyyy-mm-dd format.  If this field is not set:  * If the `serviceActivationDate` field is not set, the value of this field is set to be the contract effective date. * If the `serviceActivationDate` field is set, the value of this field is set to be the service activation date.  The billing trigger dates must follow this rule:  contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate  | [optional] 
-**external_catalog_plan_id** | **String** | An external ID of the rate plan to be removed. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to remove the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.  **Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.  | [optional] 
-**external_id_source_system** | **String** | The ID of the external source system. You can use this field and `externalCatalogPlanId` to specify a product rate plan that is imported from an external system.  **Note:** If both `externalCatalogPlanId`, `externalIdSourceSystem` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.  | [optional] 
+**customer_acceptance_date** | **String** | The date when the customer accepts the contract in yyyy-mm-dd format.   If this field is not set:   * If the `serviceActivationDate` field is not set, the value of this field is set to be the contract effective date.  * If the `serviceActivationDate` field is set, the value of this field is set to be the service activation date.   The billing trigger dates must follow this rule:   contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate | [optional] 
+**external_catalog_plan_id** | **String** | An external ID of the rate plan to be removed. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to remove the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.   **Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. | [optional] 
+**external_id_source_system** | **String** | The ID of the external source system. You can use this field and `externalCatalogPlanId` to specify a product rate plan that is imported from an external system.   **Note:** If both `externalCatalogPlanId`, `externalIdSourceSystem` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. | [optional] 
 **product_rate_plan_number** | **String** | Number of a product rate plan for this subscription.  | [optional] 
-**rate_plan_id** | **String** | ID of a rate plan for this subscription. This can be the latest version or any history version of ID.  | [optional] 
-**service_activation_date** | **String** | The date when the remove amendment is activated in yyyy-mm-dd format.  You must specify a Service Activation date if the Customer Acceptance date is set. If the Customer Acceptance date is not set, the value of the `serviceActivationDate` field defaults to be the Contract Effective Date.  The billing trigger dates must follow this rule:  contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate  | [optional] 
+**rate_plan_id** | **String** | ID of a rate plan for this subscription. This can be the latest version or any history version of ID. | [optional] 
+**service_activation_date** | **String** | The date when the remove amendment is activated in yyyy-mm-dd format.   You must specify a Service Activation date if the Customer Acceptance date is set. If the Customer Acceptance date is not set, the value of the `serviceActivationDate` field defaults to be the Contract Effective Date.   The billing trigger dates must follow this rule:   contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate | [optional] 
 **subscription_rate_plan_number** | **String** | Number of a rate plan for this subscription.  | [optional] 
 
 

package/docs/RenewSubscriptionRequest.md

@@ -4,17 +4,17 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**application_order** | **[String]** | The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.  **Note:**   - This field is valid only if the `applyCredit` field is set to `true`.   - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.   - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices.  | [optional] 
-**apply_credit** | **Boolean** | If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.  **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.  | [optional] 
-**apply_credit_balance** | **Boolean** | Whether to automatically apply a credit balance to an invoice.  If the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken.   To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.  Prerequisite: `invoice` must be `true`.   **Note:**    - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.   - This field is deprecated if you have the Invoice Settlement feature enabled.  | [optional] 
-**collect** | **Boolean** | Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account.  If the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken.  Prerequisite: The `invoice` or `runBilling` field must be `true`.   **Note**: This field is only available if you set the `zuora-version` request header to `196.0` or later.  | [optional] 
+**application_order** | **[String]** | The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.   **Note:**   - This field is valid only if the `applyCredit` field is set to `true`.   - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.   - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices. | [optional] 
+**apply_credit** | **Boolean** | If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.   **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. | [optional] 
+**apply_credit_balance** | **Boolean** | Whether to automatically apply a credit balance to an invoice.   If the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken.    To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.   Prerequisite: `invoice` must be `true`.    **Note:**    - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.   - This field is deprecated if you have the Invoice Settlement feature enabled. | [optional] 
+**collect** | **Boolean** | Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account.   If the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken.   Prerequisite: The `invoice` or `runBilling` field must be `true`.    **Note**: This field is only available if you set the `zuora-version` request header to `196.0` or later. | [optional] 
 **credit_memo_reason_code** | **String** | A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code. | [optional] 
-**document_date** | **String** | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.  - If this field is specified, the specified date is used as the billing document date.  - If this field is not specified, the date specified in the `targetDate` is used as the billing document date.  | [optional] 
+**document_date** | **String** | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.   - If this field is specified, the specified date is used as the billing document date.   - If this field is not specified, the date specified in the `targetDate` is used as the billing document date. | [optional] 
 **invoice** | **Boolean** | **Note:** This field has been replaced by the `runBilling` field. The `invoice` field is only available for backward compatibility.   Creates an invoice for a subscription. The invoice generated in this operation is only for this subscription, not for the entire customer account.   If the value is `true`, an invoice is created. If the value is `false`, no action is taken. The default value is `false`.    This field is in Zuora REST API version control. Supported minor versions are `196.0` and `207.0`. To use this field in the method, you must set the zuora-version parameter to the minor version number in the request header.  | [optional] 
-**invoice_collect** | **Boolean** | **Note:** This field has been replaced by the `invoice` field and the `collect` field. `invoiceCollect` is available only for backward compatibility.   If this field is set to `true`, an invoice is generated and payment collected automatically during the subscription process. If `false`, no invoicing or payment takes place. The invoice generated in this operation is only for this subscription, not for the entire customer account.   **Note**: This field is only available if you set the `zuora-version` request header to `186.0`, `187.0`, `188.0`, or `189.0`.  | [optional] 
+**invoice_collect** | **Boolean** | **Note:** This field has been replaced by the `invoice` field  and the `collect` field. `invoiceCollect` is available only for backward compatibility.    If this field is set to `true`, an invoice is generated and payment collected automatically during the subscription process. If `false`, no invoicing or payment takes place. The invoice generated in this operation is only for this subscription, not for the entire customer account.    **Note**: This field is only available if you set the `zuora-version` request header to `186.0`, `187.0`, `188.0`, or `189.0`. | [optional] 
 **invoice_target_date** | **String** | **Note:** This field has been replaced by the `targetDate` field. The `invoiceTargetDate` field is only available for backward compatibility.   Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.   This field is in Zuora REST API version control. Supported minor versions are `207.0` and earlier.  | [optional] 
-**order_date** | **String** | The date when the order is signed. If no additinal contractEffectiveDate is provided, this order will use this order date as the contract effective date. This field must be in the `yyyy-mm-dd` format. This field is required for Orders customers only, not applicable to Orders Harmonization customers.  | [optional] 
-**run_billing** | **Boolean** | Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos).     The billing documents generated in this operation is only for this subscription, not for the entire customer account.   Possible values:  - `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created.   - `false`: No invoice is created.   **Note:** This field is in Zuora REST API version control. Supported minor versions are `211.0` or later. To use this field in the method, you must set the `zuora-version` parameter to the minor version number in the request header.  | [optional] 
-**target_date** | **String** | Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date.   **Note:** The credit memo is only available if you have the Invoice Settlement feature enabled.   This field is in Zuora REST API version control. Supported minor versions are `211.0` and later. To use this field in the method, you must set the  `zuora-version` parameter to the minor version number in the request header.  | [optional] 
+**order_date** | **String** | The date when the order is signed. If no additinal contractEffectiveDate is provided, this order will use this order date as the contract effective date.  This field must be in the `yyyy-mm-dd` format.  This field is required for Orders customers only, not applicable to Orders Harmonization customers. | [optional] 
+**run_billing** | **Boolean** | Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos).      The billing documents generated  in this operation is only for this subscription, not for the entire  customer account.    Possible values:   - `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created.    - `false`: No invoice is created.    **Note:** This field is in Zuora REST API version control. Supported  minor versions are `211.0` or later. To use this field in the method,  you must set the `zuora-version` parameter to the minor version number  in the request header. | [optional] 
+**target_date** | **String** | Date through which to calculate charges if an invoice or a credit memo is generated, as  yyyy-mm-dd. Default is current date.    **Note:** The credit memo is only available if you have the Invoice Settlement feature enabled.    This field is in Zuora REST API version control. Supported minor  versions are `211.0` and later. To use this field in the method, you  must set the  `zuora-version` parameter to the minor version number in  the request header. | [optional] 
 
 

package/docs/RenewSubscriptionResponse.md

@@ -5,15 +5,15 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **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] 
+**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] 
-**total_delta_tcv** | **Number** | Change in the total contracted value of the subscription as a result of the update. For a renewal, this is the TCV of the subscription in the new term. 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] 
+**total_delta_tcv** | **Number** | Change in the total contracted value of the subscription as a result of the update. For a renewal, this is the TCV of the subscription in the new term. It is available for Orders Harmonization and Subscribe/Amend tenants. | [optional] 
 **order_number** | **String** | The order number. It is available for Orders Tenants.  | [optional] 
 **status** | [**OrderStatus**](OrderStatus.md) |  | [optional] 
 **account_number** | **String** | The account number that this order has been created under. This is also the invoice owner of the subscriptions included in this order. It is available for Orders Tenants. | [optional] 

package/docs/ResumeSubscriptionRequest.md

@@ -4,24 +4,24 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**application_order** | **[String]** | The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.  **Note:**   - This field is valid only if the `applyCredit` field is set to `true`.   - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.   - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices.  | [optional] 
-**apply_credit** | **Boolean** | If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.  **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.  | [optional] 
-**apply_credit_balance** | **Boolean** | Whether to automatically apply a credit balance to an invoice.  If the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken.   To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.  Prerequisite: `invoice` must be `true`.   **Note:**    - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.   - This field is deprecated if you have the Invoice Settlement feature enabled.  | [optional] 
-**booking_date** | **String** | The booking date that you want to set for the amendment contract when you resume the subscription. If `extendsTerm` is `true`, which means you also extend the term, then this field is also the booking date for the Terms and Conditions amendment contract.  This field must be in the `yyyy-mm-dd` format. The default value of this field is the current date when you make the API call.   | [optional] 
-**collect** | **Boolean** | Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account.  If the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken.  Prerequisite: The `invoice` or `runBilling` field must be `true`.   **Note**: This field is only available if you set the `zuora-version` request header to `196.0` or later.  | [optional] 
-**contract_effective_date** | **String** | The date when the customer notifies you that they want to resume their subscription.  | [optional] 
+**application_order** | **[String]** | The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.   **Note:**   - This field is valid only if the `applyCredit` field is set to `true`.   - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.   - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices. | [optional] 
+**apply_credit** | **Boolean** | If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.   **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. | [optional] 
+**apply_credit_balance** | **Boolean** | Whether to automatically apply a credit balance to an invoice.   If the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken.    To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.   Prerequisite: `invoice` must be `true`.    **Note:**    - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.   - This field is deprecated if you have the Invoice Settlement feature enabled. | [optional] 
+**booking_date** | **String** | The booking date that you want to set for the amendment contract when you resume the subscription. If `extendsTerm` is `true`, which means you also extend the term, then this field is also the booking date for the Terms and Conditions amendment contract.   This field must be in the `yyyy-mm-dd` format. The default value of this field is the current date when you make the API call.  | [optional] 
+**collect** | **Boolean** | Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account.   If the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken.   Prerequisite: The `invoice` or `runBilling` field must be `true`.    **Note**: This field is only available if you set the `zuora-version` request header to `196.0` or later. | [optional] 
+**contract_effective_date** | **String** | The date when the customer notifies you that they want to resume their subscription. | [optional] 
 **credit_memo_reason_code** | **String** | A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code. | [optional] 
-**document_date** | **String** | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.  - If this field is specified, the specified date is used as the billing document date.  - If this field is not specified, the date specified in the `targetDate` is used as the billing document date.  | [optional] 
-**extends_term** | **Boolean** | Whether to extend the subscription term by the length of time the suspension is in effect.  Values: `true`, `false`.  | [optional] 
+**document_date** | **String** | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.   - If this field is specified, the specified date is used as the billing document date.   - If this field is not specified, the date specified in the `targetDate` is used as the billing document date. | [optional] 
+**extends_term** | **Boolean** | Whether to extend the subscription term by the length of time the suspension is in effect.   Values: `true`, `false`. | [optional] 
 **invoice** | **Boolean** | **Note:** This field has been replaced by the `runBilling` field. The `invoice` field is only available for backward compatibility.   Creates an invoice for a subscription. The invoice generated in this operation is only for this subscription, not for the entire customer account.   If the value is `true`, an invoice is created. If the value is `false`, no action is taken. The default value is `false`.   This field is in Zuora REST API version control. Supported minor versions are `196.0` and `207.0`. To use this field in the method, you must set the `zuora-version` parameter to the minor version number in the request header.  | [optional] 
-**invoice_collect** | **Boolean** | **Note:** This field has been replaced by the `invoice` field and the `collect` field. `invoiceCollect` is available only for backward compatibility.   If `true`, an invoice is generated and payment collected automatically during the subscription process. If `false`, no invoicing or payment takes place.  The invoice generated in this operation is only for this subscription, not for the entire customer account.   **Note**: This field is only available if you set the `zuora-version` request header to `186.0`, `187.0`, `188.0`, or `189.0`.  | [optional] 
+**invoice_collect** | **Boolean** | **Note:** This field has been replaced by the `invoice` field  and the `collect` field. `invoiceCollect` is available only for backward  compatibility.    If `true`, an invoice is generated and payment collected automatically during  the subscription process. If `false`, no invoicing or payment  takes place.  The invoice generated in this operation is only for this subscription,  not for the entire customer account.    **Note**: This field is only available if you set the `zuora-version` request header to `186.0`, `187.0`, `188.0`, or `189.0`. | [optional] 
 **invoice_target_date** | **String** | **Note:** This field has been replaced by the `targetDate` field. The `invoiceTargetDate` field is only available for backward compatibility.   Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.   This field is in Zuora REST API version control. Supported minor versions are `207.0` and earlier.  | [optional] 
-**order_date** | **String** | The date when the order is signed. If no additinal contractEffectiveDate is provided, this order will use this order date as the contract effective date. This field must be in the `yyyy-mm-dd` format. This field is required for Orders customers only, not applicable to Orders Harmonization customers.  | [optional] 
-**resume_periods** | **String** | The length of the period used to specify when the subscription is resumed. The subscription resumption takes effect after a specified period based on the suspend date or today's date. You must use this field together with the `resumePeriodsType` field to specify the period.  **Note:** This field is only applicable when the `suspendPolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`.  | [optional] 
-**resume_periods_type** | **String** | The period type used to define when the subscription resumption takes effect. The subscription resumption takes effect after a specified period based on the suspend date or today's date. You must use this field together with the `resumePeriods` field to specify the period.  Values: `Day`, `Week`, `Month`, `Year`  **Note:** This field is only applicable when the `suspendPolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`.  | [optional] 
-**resume_policy** | **String** | Resume methods. Specify a way to resume a subscription.  Values:  * `Today`: The subscription resumption takes effect on today's date.  * `FixedPeriodsFromSuspendDate`: The subscription resumption takes effect after a specified period based on the suspend date. You must specify the `resumePeriods` and `resumePeriodsType` fields to define the period.  * `SpecificDate`: The subscription resumption takes effect on a specific date. You must define the specific date in the `resumeSpecificDate` field.  * `FixedPeriodsFromToday`: The subscription resumption takes effect after a specified period based on the today's date. You must specify the `resumePeriods` and `resumePeriodsType` fields to define the period. * `suspendDate`: The subscription resumption takes effect on the date of suspension of the subscription.  | 
-**resume_specific_date** | **String** | A specific date when the subscription resumption takes effect, in the format yyyy-mm-dd.  **Note:** This field is only applicable only when the `resumePolicy` field is set to `SpecificDate`.  The value should not be earlier than the subscription suspension date.  | [optional] 
-**run_billing** | **Boolean** | Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos).     The billing documents generated in this operation is only for this subscription, not for the entire customer account.   Possible values:  - `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created.   - `false`: No invoice is created.   **Note:** This field is in Zuora REST API version control. Supported minor versions are `211.0` or later. To use this field in the method, you must set the `zuora-version` parameter to the minor version number in the request header.  | [optional] 
-**target_date** | **String** | Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date.   **Note:** The credit memo is only available if you have the Invoice Settlement feature enabled.   This field is in Zuora REST API version control. Supported minor versions are `211.0` and later. To use this field in the method, you must set the  `zuora-version` parameter to the minor version number in the request header.  | [optional] 
+**order_date** | **String** | The date when the order is signed. If no additinal contractEffectiveDate is provided, this order will use this order date as the contract effective date.  This field must be in the `yyyy-mm-dd` format.  This field is required for Orders customers only, not applicable to Orders Harmonization customers. | [optional] 
+**resume_periods** | **String** | The length of the period used to specify when the subscription is resumed. The subscription resumption takes effect after a specified period based on the suspend date or today's date. You must use this field together with the `resumePeriodsType` field to specify the period.   **Note:** This field is only applicable when the `suspendPolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. | [optional] 
+**resume_periods_type** | **String** | The period type used to define when the subscription resumption takes effect. The subscription resumption takes effect after a specified period based on the suspend date or today's date. You must use this field together with the `resumePeriods` field to specify the period.   Values: `Day`, `Week`, `Month`, `Year`   **Note:** This field is only applicable when the `suspendPolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. | [optional] 
+**resume_policy** | **String** | Resume methods. Specify a way to resume a subscription.   Values:   * `Today`: The subscription resumption takes effect on today's date.   * `FixedPeriodsFromSuspendDate`: The subscription resumption takes effect after a specified period based on the suspend date. You must specify the `resumePeriods` and `resumePeriodsType` fields to define the period.   * `SpecificDate`: The subscription resumption takes effect on a specific date. You must define the specific date in the `resumeSpecificDate` field.   * `FixedPeriodsFromToday`: The subscription resumption takes effect after a specified period based on the today's date. You must specify the `resumePeriods` and `resumePeriodsType` fields to define the period.  * `suspendDate`: The subscription resumption takes effect on the date of suspension of the subscription. | 
+**resume_specific_date** | **String** | A specific date when the subscription resumption takes effect, in the format yyyy-mm-dd.   **Note:** This field is only applicable only when the `resumePolicy` field is set to `SpecificDate`.   The value should not be earlier than the subscription suspension date. | [optional] 
+**run_billing** | **Boolean** | Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos).      The billing documents generated  in this operation is only for this subscription, not for the entire  customer account.    Possible values:   - `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created.    - `false`: No invoice is created.    **Note:** This field is in Zuora REST API version control. Supported  minor versions are `211.0` or later. To use this field in the method,  you must set the `zuora-version` parameter to the minor version number  in the request header. | [optional] 
+**target_date** | **String** | Date through which to calculate charges if an invoice or a credit memo is generated, as  yyyy-mm-dd. Default is current date.    **Note:** The credit memo is only available if you have the Invoice Settlement feature enabled.    This field is in Zuora REST API version control. Supported minor  versions are `211.0` and later. To use this field in the method, you  must set the  `zuora-version` parameter to the minor version number in  the request header. | [optional] 
 
 

package/docs/ResumeSubscriptionResponse.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**credit_memo_id** | **String** | The credit memo ID, if a credit memo is generated during the subscription process.  **Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later in the request header, and you have  [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.  | [optional] 
+**credit_memo_id** | **String** | The credit memo ID, if a credit memo is generated during the subscription process.   **Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later in the request header, and you have  [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. | [optional] 
 **invoice_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] 
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **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] 
+**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] 
 **status** | [**OrderStatus**](OrderStatus.md) |  | [optional] 
 **account_number** | **String** | The account number that this order has been created under. This is also the invoice owner of the subscriptions included in this order. It is available for Orders Tenants. | [optional] 

package/docs/ReverseCreditMemoRequest.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**apply_effective_date** | **String** | The date when the to-be-reversed credit memo is applied to the newly generated debit memo, in `yyyy-mm-dd` format. The effective date must be later than or equal to the memo date.  The default value is the date when you reverse the credit memo and create the debit memo.  | [optional] 
+**apply_effective_date** | **String** | The date when the to-be-reversed credit memo is applied to the newly generated debit memo, in `yyyy-mm-dd` format. The effective date must be later than or equal to the memo date.   The default value is the date when you reverse the credit memo and create the debit memo. | [optional] 
 **comment** | **String** | Comments about the debit memo.  | [optional] 
-**memo_date** | **String** | The date when the debit memo is created, in `yyyy-mm-dd` format. The memo date must be later than or equal to the credit memo's memo date.  The default value is the date when you reverse the credit memo and create the debit memo.  | [optional] 
-**reason_code** | **String** | A code identifying the reason for the transaction. The value must be an existing reason code or empty. The default value is `Credit memo reversal`.  | [optional] 
+**memo_date** | **String** | The date when the debit memo is created, in `yyyy-mm-dd` format. The memo date must be later than or equal to the credit memo's memo date.   The default value is the date when you reverse the credit memo and create the debit memo. | [optional] 
+**reason_code** | **String** | A code identifying the reason for the transaction. The value must be an existing reason code or empty. The default value is `Credit memo reversal`. | [optional] 
 
 

package/docs/ReverseCreditMemoResponse.md

@@ -7,8 +7,11 @@ 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]
 **credit_memo** | [**ReverseCreditMemoResponseCreditMemo**](ReverseCreditMemoResponseCreditMemo.md) |  | [optional] 
 **debit_memo** | [**ReverseCreditMemoResponseDebitMemo**](ReverseCreditMemoResponseDebitMemo.md) |  | [optional] 
+**id** | **String** | The ID of credit memo | [optional] 
+**job_id** | **String** | The ID of the operation job. | [optional] 
+**job_status** | [**OperationJobStatus**](OperationJobStatus.md) |  | [optional] 
 
 

package/docs/ReverseInvoiceRequest.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**apply_effective_date** | **String** | The date when the credit memo is applied to the invoice that will be reversed, in `yyyy-mm-dd` format. The effective date must be later than or equal to the memo date.  The default value is the date when you reverse the invoice and create the credit memo.  | [optional] 
+**apply_effective_date** | **String** | The date when the credit memo is applied to the invoice that will be reversed, in `yyyy-mm-dd` format. The effective date must be later than or equal to the memo date.   The default value is the date when you reverse the invoice and create the credit memo. | [optional] 
 **comment** | **String** | Comments about the reversal. The comment is used as the comment of the credit memo generated by reversing the specified invoice.  | [optional] 
-**memo_date** | **String** | The date when the credit memo was created, in `yyyy-mm-dd` format. The memo date must be later than or equal to the invoice date.  The default value is the date when you reverse the invoice and create the credit memo.  | [optional] 
+**memo_date** | **String** | The date when the credit memo was created, in `yyyy-mm-dd` format. The memo date must be later than or equal to the invoice date.   The default value is the date when you reverse the invoice and create the credit memo. | [optional] 
 **reason_code** | **String** | A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code `Invoice reversal` for the credit memo.  | [optional] 
 
 

package/docs/ReverseInvoiceResponse.md

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

package/docs/ReversePaymentRequest.md

@@ -4,14 +4,14 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**amount** | **Number** | The amount that needs to be reversed (chargeback). It cannot be greater than the total Payment amount.   | 
+**amount** | **Number** | The amount that needs to be reversed (chargeback). It cannot be greater than the total Payment amount.  | 
 **gateway_reconciliation_reason** | **String** | The reason of gateway reconciliation.  | [optional] 
 **gateway_reconciliation_status** | **String** | The status of gateway reconciliation.  | [optional] 
-**gateway_response** | **String** | The transaction response returned by the gateway for this transaction. If the transaction was declined, this reason is provided in the message.  | [optional] 
-**gateway_response_code** | **String** | Response message Code returned by the gateway about the transaction status.  | [optional] 
+**gateway_response** | **String** | The transaction response returned by the gateway for this transaction. If the transaction was declined, this reason is provided in the message. | [optional] 
+**gateway_response_code** | **String** | Response message Code returned by the gateway about the transaction status. | [optional] 
 **payout_id** | **String** | The payout ID from the gateway side.  | [optional] 
-**reference_id** | **String** | Unique Id generated by the gateway for each transaction. Use this ID to find the respective Zuora Payment ID.   | [optional] 
+**reference_id** | **String** | Unique Id generated by the gateway for each transaction. Use this ID to find the respective Zuora Payment ID.  | [optional] 
 **second_reference_id** | **String** | The second reference Id. Some gateways use two unique transaction IDs.  | [optional] 
-**settled_on** | **String** | The date and time of the transaction settlement. The format is `yyyy-mm-dd hh:mm:ss`.  | [optional] 
+**settled_on** | **String** | The date and time of the transaction settlement. The format is `yyyy-mm-dd hh:mm:ss`. | [optional] 
 
 

package/docs/RevertOrderResponse.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
 **request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
 **reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
-**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **account_number** | **String** | The account number for the order. | [optional] 
 **subscription_numbers** | **[String]** | The subscriptionNumber on which revert is applied. | [optional] 
 **order_number** | **String** | The order number of the order created(reverting order). | [optional]