zuora-sdk-js 3.6.0 → 3.7.0

package/docs/GetUsageRateDetailRequestData.md

@@ -5,13 +5,13 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **amount_without_tax** | **Number** | The amount of the invoice item without tax.  | [optional] 
-**charge_number** | **String** | The unique number of the product rate plan charge associated with the invoice item.  | [optional] 
+**charge_number** | **String** | The unique number of the product rate plan charge associated with the invoice item. | [optional] 
 **invoice_id** | **String** | The unique ID of the invoice.  | [optional] 
 **invoice_item_id** | **String** | The unique ID of the invoice item.  | [optional] 
 **invoice_number** | **String** | The unique number of the invoice.  | [optional] 
-**list_price** | **String** | The list price of the product rate plan charge associated with the invoice item. For example, if the product rate plan charge uses the tiered charge model, its list price could be:   Tier / From / To / List Price / Price Format\\n1 / 0 / 9 / 0.00 / Per Unit\\n2 / 10 / 20 / 1.00 / Per Unit\\n3 / 21 / 30 / 2.00 / Flat Fee\\n4 / 31 /   / 3.00 / Per Unit\\n  | [optional] 
+**list_price** | **String** | The list price of the product rate plan charge associated with the invoice item. For example, if the product rate plan charge uses the tiered charge model, its list price could be:    Tier / From / To / List Price / Price Format\\n1 / 0 / 9 / 0.00 / Per Unit\\n2 / 10 / 20 / 1.00 / Per Unit\\n3 / 21 / 30 / 2.00 / Flat Fee\\n4 / 31 /   / 3.00 / Per Unit\\n | [optional] 
 **quantity** | **String** | The quantity of the invoice item.  | [optional] 
-**rate_detail** | **String** | The rate detail of the invoice item. It shows how the total amount is calculated. For example, if the product rate plan charge uses the tiered charge model, the rate detail for the associated invoice item could be:   Tier 1: 0-9, 9 Each(s) x $0.00/Each = $0.00\\nTier 2: 10-20, 11 Each(s) x $1.00/Each = $11.00\\nTier 3: 21-30, $2.00 Flat Fee\\nTier 4: >=31, 15 Each(s) x $3.00/Each = $45.00\\nTotal = $58.00.   The rate detail retrieved from this REST API operation is the same as the [Rate Detail presented on PDF invoices](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/Create_a_custom_invoice_template/DD_Display_Usage_Charge_Breakdown#How_UsageSummary.RateDetail_is_displayed_on_invoices).   | [optional] 
+**rate_detail** | **String** | The rate detail of the invoice item. It shows how the total amount is calculated. For example, if the product rate plan charge uses the tiered charge model, the rate detail for the associated invoice item could be:    Tier 1: 0-9, 9 Each(s) x $0.00/Each = $0.00\\nTier 2: 10-20, 11 Each(s) x $1.00/Each = $11.00\\nTier 3: 21-30, $2.00 Flat Fee\\nTier 4: >=31, 15 Each(s) x $3.00/Each = $45.00\\nTotal = $58.00.    The rate detail retrieved from this REST API operation is the same as the [Rate Detail presented on PDF invoices](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/Create_a_custom_invoice_template/DD_Display_Usage_Charge_Breakdown#How_UsageSummary.RateDetail_is_displayed_on_invoices).  | [optional] 
 **service_period** | **String** | The service period of the invoice item.  | [optional] 
 **uom** | **String** | The unit of measurement of the invoice item.  | [optional] 
 

package/docs/GetUsageResponse.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **account_id** | **String** |  The ID of the account associated with the usage data. This field is required if no value is specified for the `AccountNumber` field. **Character limit**: 32 **Values**: a valid account ID | [optional] 
 **account_number** | **String** |  The number of the account associated with the usage data. This field is required if no value is specified for the `AccountId` field. **Character limit**: 50 **Values**: a valid account number | [optional] 
 **subscription_id** | **String** |  The original ID of the subscription that contains the fees related to the usage data. **Character limit**: 32 **Values**: a valid subscription ID | [optional] 
-**subscription_number** | **String** | The unique identifier number of the subscription that contains the fees related to the usage data.  | [optional] 
+**subscription_number** | **String** | The unique identifier number of the subscription that contains the fees related to the usage data. | [optional] 
 **charge_id** | **String** |  The OrginalId of the rate plan charge related to the usage record, e.g., `2c9081a03c63c94c013c6873357a0117` **Character limit**: 32 **Values**: a valid rate plan charge OriginalID  | [optional] 
 **charge_number** | **String** | Number of the rate-plan charge that pays for this usage.  | [optional] 
 **start_date_time** | **Date** |  The start date and time of a range of time when usage is tracked. Zuora uses this field value to determine the usage date. Unlike the `EndDateTime`, the `StartDateTime` field does affect usage calculation. **Character limit**: 29 **Values**: a valid date and time value | [optional] 

package/docs/GetUsagesByAccountResponse.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent.  | [optional] 
+**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent. | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully.  | [optional] 
 **usage** | [**[UsageItem]**](UsageItem.md) | Contains one or more usage items.  | [optional] 
 

package/docs/GetWorkflowsResponsePagination.md

@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **next_page** | **String** | A string containing the URL where the next page of data can be retrieved.  | [optional] 
 **page** | **Number** | An integer denoting the current page number.  | [optional] 
-**page_length** | **Number** | An integer denoting the number of workflows in this response. The maximum value is 50.  | [optional] 
+**page_length** | **Number** | An integer denoting the number of workflows in this response. The maximum value is 50. | [optional] 
 
 

package/docs/HostedPageResponse.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **page_id** | **String** | Page ID of the Payment Page that Zuora assigns when it is created.  | [optional] 
 **page_name** | **String** | Name of the Payment Page that specified during the page configuration.  | [optional] 
-**page_type** | **String** | Payment method type of this Payment Page, e.g. 'Credit Card', 'ACH', or 'Bank Transfer'.  | [optional] 
+**page_type** | **String** | Payment method type of this Payment Page, e.g. 'Credit Card', 'ACH', or 'Bank Transfer'. | [optional] 
 **page_version** | **String** | Version of the Payment Page. 2 for Payment Pages 2.0.  | [optional] 
 
 

package/docs/HostedPagesApi.md

@@ -32,7 +32,7 @@ let opts = {
   'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). 
   'zuora_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. 
-  'version_number': "version_number_example", // String | Version of the Payment Pages for which you want to retrieve the configuration information. Specify 2 for Payment Pages 2.0. 
+  'version_number': "version_number_example", // String | Version of the Payment Pages for which you want to retrieve the configuration information. Specify 2 for Payment Pages 2.0.
   '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. 
 };
@@ -54,7 +54,7 @@ Name | Type | Description  | Notes
  **authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).  | [optional] 
  **zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.  The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).  | [optional] 
  **zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  | [optional] 
- **version_number** | **String**| Version of the Payment Pages for which you want to retrieve the configuration information. Specify 2 for Payment Pages 2.0.  | [optional] 
+ **version_number** | **String**| Version of the Payment Pages for which you want to retrieve the configuration information. Specify 2 for Payment Pages 2.0. | [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] 
 

package/docs/IneligibleBillingAdjustment.md

@@ -8,15 +8,15 @@ Name | Type | Description | Notes
 **adjustment_number** | **String** | The system generated Adjustment Number.  | [optional] 
 **amount** | **Number** | The amount of the adjustment.  | [optional] 
 **billing_date** | **String** | The billing date of the adjustment.  | [optional] 
-**charge_number** | **String** | The charge number in the subscription for which the adjustment is created.  | [optional] 
-**deferred_revenue_accounting_code** | **String** | The accounting code for the deferred revenue, such as Monthly Recurring Liability.  | [optional] 
+**charge_number** | **String** | The charge number in the subscription for which the adjustment is created. | [optional] 
+**deferred_revenue_accounting_code** | **String** | The accounting code for the deferred revenue, such as Monthly Recurring Liability. | [optional] 
 **delivery_date** | **String** | The adjustment date, in `yyyy-mm-dd` format.  | [optional] 
 **delivery_day** | **String** | The adjustment day of the week.  | [optional] 
 **eligible** | **Boolean** | The eligible flag is set as false for an unsuccessful adjustment.  | [optional] 
-**error_message** | **String** | The reason due to which an adjustment is not eligible on the given date.   | [optional] 
+**error_message** | **String** | The reason due to which an adjustment is not eligible on the given date.  | [optional] 
 **reason** | **String** | The reason for the adjustment.  | [optional] 
-**recognized_revenue_accounting_code** | **String** | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.  | [optional] 
-**revenue_recognition_rule_name** | **String** | The name of the revenue recognition rule governing the revenue schedule.  | [optional] 
+**recognized_revenue_accounting_code** | **String** | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. | [optional] 
+**revenue_recognition_rule_name** | **String** | The name of the revenue recognition rule governing the revenue schedule. | [optional] 
 **status** | **String** | The status of the adjustment.  | [optional] 
 **subscription_number** | **String** | The subscription number for which the adjustment is created.  | [optional] 
 

package/docs/IntervalPricingTier.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **tier** | **Number** | Unique number of the tier.  | [optional] 
 **starting_unit** | **Number** | Decimal defining start of tier range.  | [optional] 
 **ending_unit** | **Number** | Decimal defining end of tier range.  | [optional] 
-**price** | **Number** | The decimal value of the tiered charge model. If the charge model is not a tiered type then this price field will be null and the `price` field directly under the `productRatePlanCharges` applies.  | [optional] 
+**price** | **Number** | The decimal value of the tiered charge model. If the charge model is not a tiered type then this price field will be null and the `price` field directly under the `productRatePlanCharges` applies. | [optional] 
 **price_format** | **String** | Tier price format. Allowed values: `flat fee`, `per unit`.  | [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] 
 **is_overage_price** | **Boolean** |  | [optional] 

package/docs/Invoice.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**integration_status__ns** | **String** | Status of the invoice's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**sync_date__ns** | **String** | Date when the invoice was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**integration_status__ns** | **String** | Status of the invoice's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**sync_date__ns** | **String** | Date when the invoice was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
 **account_id** | **String** | The ID of the customer account associated with the invoice. | [optional] 
 **adjustment_amount** | **Number** | The amount of the invoice adjustments associated with the invoice. | [optional] 
 **amount** | **Number** | The total amount of the invoice. | [optional] 

package/docs/InvoiceFile.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **String** | The ID of the invoice PDF file. This is the ID for the file object and different from the file handle ID in the `pdfFileUrl` field. To open a file, you have to use the file handle ID.  | [optional] 
-**pdf_file_url** | **String** | The REST URL for the invoice PDF file. Click the URL to open the invoice PDF file.  | [optional] 
+**id** | **String** | The ID of the invoice PDF file. This is the ID for the file object and different from the file handle ID in the `pdfFileUrl` field. To open a file, you have to use the file handle ID. | [optional] 
+**pdf_file_url** | **String** | The REST URL for the invoice PDF file. Click the URL to open the invoice PDF file. | [optional] 
 **version_number** | **Number** | The version number of the invoice PDF file.  | [optional] 
 
 

package/docs/InvoiceFilesResponse.md

@@ -9,6 +9,6 @@ Name | Type | Description | Notes
 **reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully. | [optional] 
 **invoice_files** | [**[InvoiceFile]**](InvoiceFile.md) | Container for invoice PDF files.  | [optional] 
-**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent.  | [optional] 
+**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent. | [optional] 
 
 

package/docs/InvoiceItem.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**integration_status__ns** | **String** | Status of the invoice item's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**sync_date__ns** | **String** | Date when the invoice item was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**integration_status__ns** | **String** | Status of the invoice item's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**sync_date__ns** | **String** | Date when the invoice item was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
 **accounting_code** | **String** | The accounting code associated with the invoice item. | [optional] 
 **adjustment_liability_accounting_code** | **String** | The accounting code for adjustment liability.         **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.   | [optional] 
 **adjustment_revenue_accounting_code** | **String** | The accounting code for adjustment revenue.         **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.   | [optional] 

package/docs/InvoiceItemObjectNSFields.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**integration_status__ns** | **String** | Status of the invoice item's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**sync_date__ns** | **String** | Date when the invoice item was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**integration_status__ns** | **String** | Status of the invoice item's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**sync_date__ns** | **String** | Date when the invoice item was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
 
 

package/docs/InvoiceItemsResponse.md

@@ -9,6 +9,6 @@ Name | Type | Description | Notes
 **reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
 **success** | **Boolean** | Returns `true` if the request was processed successfully. | [optional] 
 **invoice_items** | [**[InvoiceItem]**](InvoiceItem.md) | Container for invoice items.  | [optional] 
-**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent.  | [optional] 
+**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent. | [optional] 
 
 

package/docs/InvoiceObjectNSFields.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**integration_status__ns** | **String** | Status of the invoice's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**sync_date__ns** | **String** | Date when the invoice was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**integration_status__ns** | **String** | Status of the invoice's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**sync_date__ns** | **String** | Date when the invoice was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
 
 

package/docs/InvoiceResponse.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_id** | **String** | The ID of the customer account associated with the invoice. | [optional] 
 **adjustment_amount** | **Number** | The amount of the invoice adjustments associated with the invoice. | [optional] 
 **amount** | **Number** | The total amount of the invoice. | [optional] 
@@ -61,9 +61,9 @@ Name | Type | Description | Notes
 **transferred_to_accounting** | [**TransferredToAccountingStatus**](TransferredToAccountingStatus.md) |  | [optional] 
 **updated_by_id** | **String** | The ID of the Zuora user who last updated the invoice. | [optional] 
 **updated_date** | **String** | The date when the invoice was last updated. | [optional] 
-**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**integration_status__ns** | **String** | Status of the invoice's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**sync_date__ns** | **String** | Date when the invoice was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**integration_status__ns** | **String** | Status of the invoice's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**sync_date__ns** | **String** | Date when the invoice was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
 
 
 

package/docs/InvoiceScheduleResponse.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_id** | **String** | The ID of the customer account that the invoice schedule belongs to.  | [optional] 
 **actual_amount** | **Number** | The actual amount that needs to be billed during the processing of the invoice schedule.  By default, the actual amount is the same as the total amount. Even if order changes occur like Remove Product or Cancel Subscription, the value of the `totalAmount` field keeps unchanged. The value of the `actualAmount` field reflects the actual amount to be billed.  | [optional] 
 **additional_subscriptions_to_bill** | **[String]** | A list of the numbers of the subscriptions that need to be billed together with the invoice schedule.   One invoice schedule can have at most 600 additional subscriptions.  | [optional] 

package/docs/InvoiceScheduleSubscription.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **order_key** | **String** | The unique ID or number of the order associated with the invoice schedule.  | [optional] 
-**subscription_key** | **String** | The unique number of the subscription contained in the order associated with the invoice schedule.  | [optional] 
-**charge_numbers** | **[String]** | A list of the numbers of charges contained in the subscription\"  | [optional] 
+**subscription_key** | **String** | The unique number of the subscription contained in the order associated with the invoice schedule. | [optional] 
+**charge_numbers** | **[String]** | A list of the numbers of charges contained in the subscription\" | [optional] 
 
 

package/docs/InvoiceSchedulesApi.md

@@ -34,7 +34,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.InvoiceSchedulesApi();
-let schedule_key = "schedule_key_example"; // String | The unique ID or number of the schedule to be paused. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. 
+let schedule_key = "schedule_key_example"; // String | The unique ID or number of the schedule to be paused. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.
 let attach_invoice_schedule_request = new ZuoraSdkJs.AttachInvoiceScheduleRequest(); // AttachInvoiceScheduleRequest | 
 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. 
@@ -58,7 +58,7 @@ apiInstance.attachInvoiceSchedule(schedule_key, attach_invoice_schedule_request,
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **schedule_key** | **String**| The unique ID or number of the schedule to be paused. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.  | 
+ **schedule_key** | **String**| The unique ID or number of the schedule to be paused. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. | 
  **attach_invoice_schedule_request** | [**AttachInvoiceScheduleRequest**](AttachInvoiceScheduleRequest.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] 
@@ -166,7 +166,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.InvoiceSchedulesApi();
-let schedule_key = "schedule_key_example"; // String | The unique ID or number of the invoice schedule to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. 
+let schedule_key = "schedule_key_example"; // String | The unique ID or number of the invoice schedule to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.
 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. 
@@ -189,7 +189,7 @@ apiInstance.deleteInvoiceSchedule(schedule_key, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **schedule_key** | **String**| The unique ID or number of the invoice schedule to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.  | 
+ **schedule_key** | **String**| The unique ID or number of the invoice schedule to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. | 
  **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] 
@@ -230,7 +230,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.InvoiceSchedulesApi();
-let schedule_key = "schedule_key_example"; // String | The unique ID or number of the schedule to be paused. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. 
+let schedule_key = "schedule_key_example"; // String | The unique ID or number of the schedule to be paused. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.
 let detach_invoice_schedule_request = new ZuoraSdkJs.DetachInvoiceScheduleRequest(); // DetachInvoiceScheduleRequest | 
 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. 
@@ -254,7 +254,7 @@ apiInstance.detachInvoiceSchedule(schedule_key, detach_invoice_schedule_request,
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **schedule_key** | **String**| The unique ID or number of the schedule to be paused. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.  | 
+ **schedule_key** | **String**| The unique ID or number of the schedule to be paused. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. | 
  **detach_invoice_schedule_request** | [**DetachInvoiceScheduleRequest**](DetachInvoiceScheduleRequest.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] 
@@ -284,7 +284,7 @@ Name | Type | Description  | Notes
 
 Execute an invoice schedule
 
-Executes an invoice schedule immediately.  During the execution, a bill run is created and generates an invoice or a credit memo asynchronously.  When you use this API operation to execute an invoice schedule item, you have the flexibility to decide whether to specify a specific item ID.  - If you specify the unique ID of an invoice schedule item to be executed in the request, the corresponding invoice schedule item is executed. - If you do not specify the ID of any invoice schedule item in the request, the subscription end date is used as the target date to determine the next pending schedule item to be executed.   For more samples, see [Execute invoice schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Schedule/Billing_Schedule_tutorials/Execute_invoice_schedules). 
+Executes an invoice schedule immediately.  During the execution, a bill run is created and generates an invoice or a credit memo asynchronously. nWhen you use this API operation to execute an invoice schedule item, you have the flexibility to decide whether to specify a specific item ID.  - If you specify the unique ID of an invoice schedule item to be executed in the request, the corresponding invoice schedule item is executed. - If you do not specify the ID of any invoice schedule item in the request, the subscription end date is used as the target date to determine the next pending schedule item to be executed.   For more samples, see [Execute invoice schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Schedule/Billing_Schedule_tutorials/Execute_invoice_schedules). 
 
 ### Example
 
@@ -296,7 +296,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.InvoiceSchedulesApi();
-let schedule_key = "schedule_key_example"; // String | The unique ID or number of the schedule to be executed. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. 
+let schedule_key = "schedule_key_example"; // String | The unique ID or number of the schedule to be executed. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.
 let request = new ZuoraSdkJs.ExecuteInvoiceScheduleRequest(); // ExecuteInvoiceScheduleRequest | 
 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.  
@@ -321,7 +321,7 @@ apiInstance.executeInvoiceSchedule(schedule_key, request, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **schedule_key** | **String**| The unique ID or number of the schedule to be executed. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.  | 
+ **schedule_key** | **String**| The unique ID or number of the schedule to be executed. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. | 
  **request** | [**ExecuteInvoiceScheduleRequest**](ExecuteInvoiceScheduleRequest.md)|  | 
  **idempotency_key** | **String**| Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.   With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.   | [optional] 
  **accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.  | [optional] 
@@ -364,7 +364,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.InvoiceSchedulesApi();
-let schedule_key = "schedule_key_example"; // String | The unique ID or number of the invoice schedule to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. 
+let schedule_key = "schedule_key_example"; // String | The unique ID or number of the invoice schedule to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.
 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. 
@@ -387,7 +387,7 @@ apiInstance.getInvoiceSchedule(schedule_key, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **schedule_key** | **String**| The unique ID or number of the invoice schedule to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.  | 
+ **schedule_key** | **String**| The unique ID or number of the invoice schedule to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. | 
  **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] 
@@ -428,7 +428,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.InvoiceSchedulesApi();
-let schedule_key = "schedule_key_example"; // String | The unique ID or number of the schedule to be paused. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. 
+let schedule_key = "schedule_key_example"; // String | The unique ID or number of the schedule to be paused. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.
 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. 
@@ -451,7 +451,7 @@ apiInstance.pauseInvoiceSchedule(schedule_key, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **schedule_key** | **String**| The unique ID or number of the schedule to be paused. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.  | 
+ **schedule_key** | **String**| The unique ID or number of the schedule to be paused. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. | 
  **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] 
@@ -492,7 +492,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.InvoiceSchedulesApi();
-let schedule_key = "schedule_key_example"; // String | The unique ID or number of the schedule to be resumed. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. 
+let schedule_key = "schedule_key_example"; // String | The unique ID or number of the schedule to be resumed. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.
 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. 
@@ -515,7 +515,7 @@ apiInstance.resumeInvoiceSchedule(schedule_key, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **schedule_key** | **String**| The unique ID or number of the schedule to be resumed. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.  | 
+ **schedule_key** | **String**| The unique ID or number of the schedule to be resumed. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. | 
  **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] 
@@ -544,7 +544,7 @@ Name | Type | Description  | Notes
 
 Update an invoice schedule
 
-Updates a pending invoice schedule.  You can use this API operation to update invoice schedules in the following aspects: - Update notes and pending invoice schedule items - Update orders associated with invoice schedules - Remove or add invoice schedule items  For more samples, see [Edit invoice schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Schedule/Billing_Schedule_tutorials/Edit_invoice_schedules).  ### Restrictions and limitations   When updating invoice schedules through the REST API, keep the following restrictions and limitations in mind: - You can only update invoice schedule items in Pending status. - You can only add orders or specific subscriptions to pending invoice schedules, and remove orders or specific subscriptions from pending invoice schedules. - For the invoice schedule items that you want to update, you must include the new values for these items in the request. - For the invoice schedule items that you want to keep unchanged, you must include all the existing information about these items in the request. Otherwise, the existing invoice schedule items that you do not mention in the request are deleted. - For the orders that you want to keep unchanged for an invoice schedule, you must include all the existing order numbers associated with the invoice schedule in the request. Otherwise, the existing orders that you do not mention in the request are removed. 
+Updates a pending invoice schedule.  You can use this API operation to update invoice schedules in the following aspects: - Update notes and pending invoice schedule items - Update orders associated with invoice schedules - Remove or add invoice schedule items  For more samples, see [Edit invoice schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Schedule/Billing_Schedule_tutorials/Edit_invoice_schedules). n### Restrictions and limitations   When updating invoice schedules through the REST API, keep the following restrictions and limitations in mind: - You can only update invoice schedule items in Pending status. - You can only add orders or specific subscriptions to pending invoice schedules, and remove orders or specific subscriptions from pending invoice schedules. - For the invoice schedule items that you want to update, you must include the new values for these items in the request. - For the invoice schedule items that you want to keep unchanged, you must include all the existing information about these items in the request. Otherwise, the existing invoice schedule items that you do not mention in the request are deleted. - For the orders that you want to keep unchanged for an invoice schedule, you must include all the existing order numbers associated with the invoice schedule in the request. Otherwise, the existing orders that you do not mention in the request are removed. 
 
 ### Example
 
@@ -556,7 +556,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.InvoiceSchedulesApi();
-let schedule_key = "schedule_key_example"; // String | The unique ID or number of the invoice schedule to be updated. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. 
+let schedule_key = "schedule_key_example"; // String | The unique ID or number of the invoice schedule to be updated. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.
 let request = new ZuoraSdkJs.UpdateInvoiceScheduleRequest(); // UpdateInvoiceScheduleRequest | 
 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. 
@@ -580,7 +580,7 @@ apiInstance.updateInvoiceSchedule(schedule_key, request, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **schedule_key** | **String**| The unique ID or number of the invoice schedule to be updated. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.  | 
+ **schedule_key** | **String**| The unique ID or number of the invoice schedule to be updated. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. | 
  **request** | [**UpdateInvoiceScheduleRequest**](UpdateInvoiceScheduleRequest.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/InvoiceSettlementAsyncJobResponse.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]
 **id** | **String** | The ID of the operation job. | [optional] 
 **status** | [**InvoiceSettlementAsyncJobStatus**](InvoiceSettlementAsyncJobStatus.md) |  | [optional] 
 **operation_type** | [**InvoiceSettlementAsyncJobOperationType**](InvoiceSettlementAsyncJobOperationType.md) |  | [optional]