zuora-sdk-js 3.8.0 → 3.9.0-beta.2

package/docs/ObjectQueriesApi.md

@@ -11,8 +11,10 @@ Method | HTTP request | Description
 [**queryBillingRunByKey**](ObjectQueriesApi.md#queryBillingRunByKey) | **GET** /object-query/billing-runs/{key} | 
 [**queryBillingRuns**](ObjectQueriesApi.md#queryBillingRuns) | **GET** /object-query/billing-runs | 
 [**queryCommitmentByKey**](ObjectQueriesApi.md#queryCommitmentByKey) | **GET** /object-query/commitment/{key} | 
-[**queryCommitmentSegmentByKey**](ObjectQueriesApi.md#queryCommitmentSegmentByKey) | **GET** /object-query/commitmentSegment/{key} | 
-[**queryCommitmentSegments**](ObjectQueriesApi.md#queryCommitmentSegments) | **GET** /object-query/commitmentSegment | 
+[**queryCommitmentCycleByKey**](ObjectQueriesApi.md#queryCommitmentCycleByKey) | **GET** /object-query/commitment-cycle/{key} | 
+[**queryCommitmentCycles**](ObjectQueriesApi.md#queryCommitmentCycles) | **GET** /object-query/commitment-cycle | 
+[**queryCommitmentSegmentByKey**](ObjectQueriesApi.md#queryCommitmentSegmentByKey) | **GET** /object-query/commitment-segment/{key} | 
+[**queryCommitmentSegments**](ObjectQueriesApi.md#queryCommitmentSegments) | **GET** /object-query/commitment-segment | 
 [**queryCommitments**](ObjectQueriesApi.md#queryCommitments) | **GET** /object-query/commitment | 
 [**queryContactByKey**](ObjectQueriesApi.md#queryContactByKey) | **GET** /object-query/contacts/{key} | 
 [**queryContactSnapshotByKey**](ObjectQueriesApi.md#queryContactSnapshotByKey) | **GET** /object-query/contact-snapshots/{key} | 
@@ -665,6 +667,164 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## queryCommitmentCycleByKey
+
+> ExpandedCommitmentCycle queryCommitmentCycleByKey(key, opts)
+
+
+
+Query CommitmentCycle by key with filters, expands, sort capabilities. Supported expands: N/A.
+
+### 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.ObjectQueriesApi();
+let key = "key_example"; // String | Object ID or Number.
+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. 
+  '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. 
+  '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_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. 
+  'page_size': 56, // Number | The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error.
+  'cursor': "cursor_example", // String | A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
+  'sort': ["null"], // [String] | A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
+  'expand': ["null"], // [String] | Allows you to expand responses by including related object information in a single call.
+  'filter': ["null"], // [String] | A case-sensitive filter on the list.
+  'fields': ["null"], // [String] | A case-insensitive query parameter that allows you to specify which fields are returned in the response.
+  'include_null_fields': true // Boolean | An optional boolean query parameter that specifies whether to include null fields in the response. If set to `true`, all fields, including those with null values, will be included in the response. If set to `false`, only fields with non-null values will be included.
+};
+apiInstance.queryCommitmentCycleByKey(key, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **key** | **String**| Object ID or Number. | 
+ **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] 
+ **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] 
+ **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_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] 
+ **page_size** | **Number**| The maximum number of results to return in a single page. If the specified `pageSize` is less than 1 or greater than 50, Zuora will return a 400 error. | [optional] 
+ **cursor** | **String**| A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. | [optional] 
+ **sort** | [**[String]**](String.md)| A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. | [optional] 
+ **expand** | [**[String]**](String.md)| Allows you to expand responses by including related object information in a single call. | [optional] 
+ **filter** | [**[String]**](String.md)| A case-sensitive filter on the list. | [optional] 
+ **fields** | [**[String]**](String.md)| A case-insensitive query parameter that allows you to specify which fields are returned in the response. | [optional] 
+ **include_null_fields** | **Boolean**| An optional boolean query parameter that specifies whether to include null fields in the response. If set to `true`, all fields, including those with null values, will be included in the response. If set to `false`, only fields with non-null values will be included. | [optional] 
+
+### Return type
+
+[**ExpandedCommitmentCycle**](ExpandedCommitmentCycle.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## queryCommitmentCycles
+
+> QueryCommitmentCyclesResponse queryCommitmentCycles(opts)
+
+
+
+Query CommitmentCycles with filters, expands, sort capabilities. Supported expands: N/A.
+
+### 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.ObjectQueriesApi();
+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. 
+  '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. 
+  '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_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. 
+  'page_size': 56, // Number | The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error.
+  'cursor': "cursor_example", // String | A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list.
+  'sort': ["null"], // [String] | A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored.
+  'expand': ["null"], // [String] | Allows you to expand responses by including related object information in a single call.
+  'filter': ["null"], // [String] | A case-sensitive filter on the list.
+  'fields': ["null"], // [String] | A case-insensitive query parameter that allows you to specify which fields are returned in the response.
+  'include_null_fields': true // Boolean | An optional boolean query parameter that specifies whether to include null fields in the response. If set to `true`, all fields, including those with null values, will be included in the response. If set to `false`, only fields with non-null values will be included.
+};
+apiInstance.queryCommitmentCycles(opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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] 
+ **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] 
+ **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_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] 
+ **page_size** | **Number**| The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 50, Zuora will return a 400 error. | [optional] 
+ **cursor** | **String**| A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list. | [optional] 
+ **sort** | [**[String]**](String.md)| A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `accountnumber.ASC`) or descending (e.g. `accountnumber.DESC`). You cannot sort on properties in arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. | [optional] 
+ **expand** | [**[String]**](String.md)| Allows you to expand responses by including related object information in a single call. | [optional] 
+ **filter** | [**[String]**](String.md)| A case-sensitive filter on the list. | [optional] 
+ **fields** | [**[String]**](String.md)| A case-insensitive query parameter that allows you to specify which fields are returned in the response. | [optional] 
+ **include_null_fields** | **Boolean**| An optional boolean query parameter that specifies whether to include null fields in the response. If set to `true`, all fields, including those with null values, will be included in the response. If set to `false`, only fields with non-null values will be included. | [optional] 
+
+### Return type
+
+[**QueryCommitmentCyclesResponse**](QueryCommitmentCyclesResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## queryCommitmentSegmentByKey
 
 > ExpandedCommitmentSegment queryCommitmentSegmentByKey(key, opts)

package/docs/Order.md

@@ -21,6 +21,7 @@ Name | Type | Description | Notes
 **scheduled_order_activation_response** | [**CreateOrderResponse**](CreateOrderResponse.md) |  | [optional] 
 **status** | [**OrderStatus**](OrderStatus.md) |  | [optional] 
 **subscriptions** | [**[OrderSubscriptions]**](OrderSubscriptions.md) | Represents a processed subscription, including the origin request (order actions) that create this version of subscription and the processing result (order metrics). The reference part in the request will be overridden with the info in the new subscription version. | [optional] 
+**commitments** | [**[UpsertCommitmentInput]**](UpsertCommitmentInput.md) |  | [optional] 
 **updated_by** | **String** | The ID of the user who updated this order. | [optional] 
 **updated_date** | **String** | The time that the order gets updated in the system(for example, an order description update), in the `YYYY-MM-DD HH:MM:SS` format. | [optional] 
 

package/docs/OrdersApi.md

@@ -299,7 +299,7 @@ Name | Type | Description  | Notes
 
 Delete an order
 
-**Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Subscribe_and_Amend\" target=\"_blank\">Subscribe and Amend</a> customer, we recommend you enable <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/A_Overview_of_Orders_Harmonization\" target=\"_blank\">Orders Harmonization</a> to access the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/AA_Overview_of_Orders/A_Overview_of_Orders\" target=\"_blank\">Orders</a> feature. With Orders, you can access both existing functions for subscription and billing management and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/P_FAQ_about_Orders_Harmonization#New+features+through+Orders\" target=\"_blank\">new features</a> on Zuora Billing.  **Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default.          Deletes a specified order.   * All the subscriptions changed by this order are deleted. After the deletion, the subscriptions are rolled back to the previous version.   * All the order line items created in this order are deleted.  You are not allowed to delete an order if the charges that are affected by this order are invoiced. 
+**Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Subscribe_and_Amend\" target=\"_blank\">Subscribe and Amend</a> customer, we recommend you enable <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/A_Overview_of_Orders_Harmonization\" target=\"_blank\">Orders Harmonization</a> to access the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/AA_Overview_of_Orders/A_Overview_of_Orders\" target=\"_blank\">Orders</a> feature. With Orders, you can access both existing functions for subscription and billing management and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/P_FAQ_about_Orders_Harmonization#New+features+through+Orders\" target=\"_blank\">new features</a> on Zuora Billing.  **Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default.          Deletes a specified order.   * All the subscriptions changed by this order are deleted. After the deletion, the subscriptions are rolled back to the previous version.   * All the order line items created in this order are deleted.  You are not allowed to delete an order if the charges that are affected by this order are invoiced.  any changes that this order applied on the commitments will be reverted.
 
 ### Example
 

package/docs/ProrationOptionEnum.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.ProrationOptionEnum
+
+## Enum
+
+
+* `ChargeFullPeriod` (value: `"ChargeFullPeriod"`)
+
+* `DefaultFromCustomer` (value: `"DefaultFromCustomer"`)
+
+

package/docs/QueryCommitmentCyclesResponse.md

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

package/docs/RatePlanChargeSegment.md

@@ -74,6 +74,9 @@ Name | Type | Description | Notes
 **taxable** | **Boolean** |  | [optional] 
 **tax_code** | **String** |  | [optional] 
 **tax_mode** | **String** |  | [optional] 
+**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] 
 
 
 

package/docs/RatePlanChargeSegmentInfo.md

@@ -74,6 +74,9 @@ Name | Type | Description | Notes
 **taxable** | **Boolean** |  | [optional] 
 **tax_code** | **String** |  | [optional] 
 **tax_mode** | **String** |  | [optional] 
+**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] 
 
 
 

package/docs/UpdateOrderRequest.md

@@ -17,5 +17,6 @@ Name | Type | Description | Notes
 **scheduling_options** | [**OrderSchedulingOptions**](OrderSchedulingOptions.md) |  | [optional] 
 **status** | [**OrderStatus**](OrderStatus.md) |  | [optional] 
 **subscriptions** | [**[CreateOrderSubscription]**](CreateOrderSubscription.md) | Each item includes a set of order actions, which will be applied to the same base subscription. | [optional] 
+**commitments** | [**[UpsertCommitmentInput]**](UpsertCommitmentInput.md) |  | [optional] 
 
 

package/docs/UpsertCommitmentInput.md

@@ -0,0 +1,49 @@
+# ZuoraSdkJs.UpsertCommitmentInput
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | [**ActionType**](ActionType.md) |  | 
+**commitment_number** | **String** | The number of the Commitment. | 
+**name** | **String** | The value to update. Set to null to clear the existing value. | 
+**type** | [**CommitmentTypeEnum**](CommitmentTypeEnum.md) |  | 
+**description** | **String** | The value to update. Set to null to clear the existing value. | [optional] 
+**priority** | **Number** | It defines the evaluation order of the commitment, the lower the number, the higher the priority. when two commitments have the same priority, the one with the earlier created one time will be evaluated first. | 
+**proration_option** | [**ProrationOptionEnum**](ProrationOptionEnum.md) |  | 
+**default_association_rule** | [**AssociationRule**](AssociationRule.md) |  | [optional] 
+**custom_fields** | **{String: Object}** | Container for custom fields of an commitment Segment object. | [optional] 
+**cycle_period_type** | [**CyclePeriodTypeEnum**](CyclePeriodTypeEnum.md) |  | [optional] 
+**specific_cycle_period_length** | **Number** | When the cyclePeriodType is SpecificWeeks, SpecificDays or SpecificMonths, this field is required. | [optional] 
+**accounting_code** | **String** | The accounting code for the Commitment Segment.  | [optional] 
+**adjustment_liability_accounting_code** | **String** | The accounting code on the Commitment Segment object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**adjustment_revenue_accounting_code** | **String** | The accounting code on the Commitment Segment object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**contract_asset_accounting_code** | **String** | The accounting code on the Commitment Segment object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**contract_liability_accounting_code** | **String** | The accounting code on the Commitment Segment object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**contract_recognized_revenue_accounting_code** | **String** | The accounting code on the Commitment Segment object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**deferred_revenue_accounting_code** | **String** | The deferred revenue accounting code for the Commitment Segment.  | [optional] 
+**exclude_item_billing_from_revenue_accounting** | **Boolean** | The flag to exclude Commitment Segment related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.   **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.   | [optional] 
+**exclude_item_booking_from_revenue_accounting** | **Boolean** | The flag to exclude Commitment Segment from revenue accounting.  **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.  | [optional] 
+**is_allocation_eligible** | **Boolean** | This field is used to identify if the charge segment is allocation eligible in revenue recognition.  **Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.  | [optional] 
+**is_unbilled** | **Boolean** | This field is used to dictate how to perform the accounting during revenue recognition.  **Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.  | [optional] 
+**recognized_revenue_accounting_code** | **String** | The recognized revenue accounting code for the Commitment Segment.  | [optional] 
+**revenue_recognition_rule** | **String** | The Revenue Recognition rule for the Commitment Segment.  | [optional] 
+**unbilled_receivables_accounting_code** | **String** | The accounting code on the Commitment Segment object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**taxable** | **Boolean** | The flag to indicate whether the charge is taxable. If this field is set to true, both the fields `taxCode` and `taxMode` are required.  | [optional] 
+**tax_code_name** | **String** | The taxCode of a charge. This field is available when the field 'taxable' is set to true.  | [optional] 
+**tax_mode** | **String** | The taxMode of a charge.  Values: * `TaxExclusive` * `TaxInclusive` This field is available when the field 'taxable' is set to true.  | [optional] 
+**currency** | **String** |  | 
+**segments** | [**[UpsertCommitmentSegmentInput]**](UpsertCommitmentSegmentInput.md) |  | 
+
+
+
+## Enum: TaxModeEnum
+
+
+* `TaxInclusive` (value: `"TaxInclusive"`)
+
+* `TaxExclusive` (value: `"TaxExclusive"`)
+
+
+
+

package/docs/UpsertCommitmentSegmentInput.md

@@ -0,0 +1,15 @@
+# ZuoraSdkJs.UpsertCommitmentSegmentInput
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**commitment_segment_number** | **String** | The number of the Commitment Segment. | 
+**start_date** | **String** |  | 
+**end_date** | **String** |  | 
+**association_rule** | [**AssociationRule**](AssociationRule.md) |  | [optional] 
+**custom_fields** | **{String: Object}** | Container for custom fields of an commitment Segment object. | [optional] 
+**cycle_amount** | **Number** |  | 
+**action** | [**ActionType**](ActionType.md) |  | 
+
+

package/docs/UpsertCreateCommitmentInput.md

@@ -0,0 +1,49 @@
+# ZuoraSdkJs.UpsertCreateCommitmentInput
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**commitment_number** | **String** |  | [optional] 
+**name** | **String** |  | 
+**type** | [**CommitmentTypeEnum**](CommitmentTypeEnum.md) |  | 
+**description** | **String** |  | [optional] 
+**priority** | **Number** | It defines the evaluation order of the commitment, the lower the number, the higher the priority. when two commitments have the same priority, the one with the earlier created one time will be evaluated first. | 
+**proration_option** | [**ProrationOptionEnum**](ProrationOptionEnum.md) |  | 
+**default_association_rule** | [**AssociationRule**](AssociationRule.md) |  | [optional] 
+**custom_fields** | **{String: Object}** | Container for custom fields of an commitment object. | [optional] 
+**cycle_period_type** | [**CyclePeriodTypeEnum**](CyclePeriodTypeEnum.md) |  | [optional] 
+**specific_cycle_period_length** | **Number** | When the cyclePeriodType is SpecificWeeks, SpecificDays or SpecificMonths, this field is required. | [optional] 
+**accounting_code** | **String** | The accounting code for the Commitment Segment.  | [optional] 
+**adjustment_liability_accounting_code** | **String** | The accounting code on the Commitment Segment object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**adjustment_revenue_accounting_code** | **String** | The accounting code on the Commitment Segment object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**contract_asset_accounting_code** | **String** | The accounting code on the Commitment Segment object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**contract_liability_accounting_code** | **String** | The accounting code on the Commitment Segment object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**contract_recognized_revenue_accounting_code** | **String** | The accounting code on the Commitment Segment object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**deferred_revenue_accounting_code** | **String** | The deferred revenue accounting code for the Commitment Segment.  | [optional] 
+**exclude_item_billing_from_revenue_accounting** | **Boolean** | The flag to exclude Commitment Segment related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.   **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.   | [optional] 
+**exclude_item_booking_from_revenue_accounting** | **Boolean** | The flag to exclude Commitment Segment from revenue accounting.  **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.  | [optional] 
+**is_allocation_eligible** | **Boolean** | This field is used to identify if the charge segment is allocation eligible in revenue recognition.  **Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.  | [optional] 
+**is_unbilled** | **Boolean** | This field is used to dictate how to perform the accounting during revenue recognition.  **Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.  | [optional] 
+**recognized_revenue_accounting_code** | **String** | The recognized revenue accounting code for the Commitment Segment.  | [optional] 
+**revenue_recognition_rule** | **String** | The Revenue Recognition rule for the Commitment Segment.  | [optional] 
+**unbilled_receivables_accounting_code** | **String** | The accounting code on the Commitment Segment object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**taxable** | **Boolean** | The flag to indicate whether the charge is taxable. If this field is set to true, both the fields `taxCode` and `taxMode` are required.  | [optional] 
+**tax_code_name** | **String** | The taxCode of a charge. This field is available when the field 'taxable' is set to true.  | [optional] 
+**tax_mode** | **String** | The taxMode of a charge.  Values: * `TaxExclusive` * `TaxInclusive` This field is available when the field 'taxable' is set to true.  | [optional] 
+**currency** | **String** |  | 
+**segments** | [**[UpsertCreateCommitmentInputAllOfSegments]**](UpsertCreateCommitmentInputAllOfSegments.md) | The new segments are required when creating a new Commitment. | 
+**action** | [**ActionType**](ActionType.md) |  | 
+
+
+
+## Enum: TaxModeEnum
+
+
+* `TaxInclusive` (value: `"TaxInclusive"`)
+
+* `TaxExclusive` (value: `"TaxExclusive"`)
+
+
+
+

package/docs/UpsertCreateCommitmentInputAllOfSegments.md

@@ -0,0 +1,24 @@
+# ZuoraSdkJs.UpsertCreateCommitmentInputAllOfSegments
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**commitment_segment_number** | **String** | The number of the Commitment Segment. | [optional] 
+**start_date** | **String** |  | 
+**end_date** | **String** |  | 
+**association_rule** | [**AssociationRule**](AssociationRule.md) |  | [optional] 
+**custom_fields** | **{String: Object}** | Container for custom fields of an commitment Segment object. | [optional] 
+**cycle_amount** | **Number** |  | 
+**action** | **String** |  | [optional] 
+
+
+
+## Enum: ActionEnum
+
+
+* `create` (value: `"create"`)
+
+
+
+

package/docs/UpsertCreateCommitmentSegmentInput.md

@@ -0,0 +1,15 @@
+# ZuoraSdkJs.UpsertCreateCommitmentSegmentInput
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**commitment_segment_number** | **String** | The number of the Commitment Segment. | [optional] 
+**start_date** | **String** |  | 
+**end_date** | **String** |  | 
+**association_rule** | [**AssociationRule**](AssociationRule.md) |  | [optional] 
+**custom_fields** | **{String: Object}** | Container for custom fields of an commitment Segment object. | [optional] 
+**cycle_amount** | **Number** |  | 
+**action** | [**ActionType**](ActionType.md) |  | 
+
+

package/docs/UpsertUpdateCommitmentInput.md

@@ -0,0 +1,15 @@
+# ZuoraSdkJs.UpsertUpdateCommitmentInput
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | [**ActionType**](ActionType.md) |  | 
+**commitment_number** | **String** | The number of the Commitment. | 
+**name** | **String** | The value to update. Set to null to clear the existing value. | [optional] 
+**description** | **String** | The value to update. Set to null to clear the existing value. | [optional] 
+**default_association_rule** | [**AssociationRule**](AssociationRule.md) |  | [optional] 
+**custom_fields** | **{String: Object}** | Container for custom fields of an commitment Segment object. | [optional] 
+**segments** | [**[UpsertCommitmentSegmentInput]**](UpsertCommitmentSegmentInput.md) |  | [optional] 
+
+

package/docs/UpsertUpdateCommitmentSegmentInput.md

@@ -0,0 +1,13 @@
+# ZuoraSdkJs.UpsertUpdateCommitmentSegmentInput
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | [**ActionType**](ActionType.md) |  | 
+**commitment_segment_number** | **String** | The number of the Commitment Segment. | 
+**end_date** | **String** |  | [optional] 
+**cycle_amount** | **Number** |  | [optional] 
+**custom_fields** | **{String: Object}** | Container for custom fields of an commitment Segment object. | [optional] 
+
+

package/docs/UsageTieredWithOveragePricingOverride.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **overage_unused_units_credit_option** | **String** | Specifies whether to credit the customer for unused units.   If the value of this field is `CreditBySpecificRate`, use the `unusedUnitsCreditRates` field to specify the rate at which to credit the customer for unused units. | [optional] 
 **tiers** | [**[ChargeTier]**](ChargeTier.md) | List of cumulative pricing tiers in the charge.  | [optional] 
 **unused_units_credit_rates** | **Number** | Per-unit rate at which to credit the customer for unused units. Only applicable if the value of the `overageUnusedUnitsCreditOption` field is `CreditBySpecificRate`. | [optional] 
+**original_list_price** | **Number** | The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.  | [optional] 
 
 
 

package/docs/UsageTieredWithOveragePricingUpdate.md

@@ -8,5 +8,6 @@ Name | Type | Description | Notes
 **price_increase_percentage** | **Number** | Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`.  | [optional] 
 **overage_price** | **Number** |  | [optional] 
 **tiers** | [**[ChargeTier]**](ChargeTier.md) |  | [optional] 
+**original_list_price** | **Number** | The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.  | [optional] 
 
 

package/docs/VerifyPaymentMethodRequest.md

@@ -8,5 +8,6 @@ Name | Type | Description | Notes
 **gateway_options** | [**GatewayOptions**](GatewayOptions.md) |  | [optional] 
 **payment_gateway_name** | **String** | The name of the payment gateway instance. If no value is specified for this field, the default payment gateway of the customer account will be used. | [optional] 
 **security_code** | **String** | The CVV or CVV2 security code for the credit card or debit card. To ensure PCI compliance, the value of this field is not stored and cannot be queried. | [optional] 
+**cryptogram** | **String** | Cryptogram value supplied by the token provider if DPAN or network scheme token is present  To ensure PCI compliance, this value is not stored and cannot be queried.  | [optional] 
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zuora-sdk-js",
-  "version": "3.8.0",
+  "version": "3.9.0-beta.2",
   "author": {
     "name": "Zuora",
     "email": "",