zuora-sdk-js 3.3.0 → 3.4.0

package/docs/RatePlanChargeSegmentInfo.md

@@ -0,0 +1,113 @@
+# ZuoraSdkJs.RatePlanChargeSegmentInfo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**amended_by_order_on** | **String** | The date when the rate plan charge is amended through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.  | [optional] 
+**apply_discount_to** | [**ApplyDiscountTo**](ApplyDiscountTo.md) |  | [optional] 
+**charge_function** | [**ChargeFunction**](ChargeFunction.md) |  | [optional] 
+**charge_model_configuration** | [**ChargeModelConfigurationForSubscription**](ChargeModelConfigurationForSubscription.md) |  | [optional] 
+**charged_through_date** | **String** | The date through which a customer has been billed for the charge.  | [optional] 
+**commitment_type** | [**CommitmentType**](CommitmentType.md) |  | [optional] 
+**prepaid_committed_amount** | **String** |  | [optional] 
+**credit_option** | **String** | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.  To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.  The way to calculate credit. See [Credit Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option) for more information.  | [optional] 
+**currency** | **String** | Currency used by the account. For example, `USD` or `EUR`. | [optional] 
+**delivery_schedule** | [**DeliverySchedule**](DeliverySchedule.md) |  | [optional] 
+**number_of_deliveries** | **Number** |  | [optional] 
+**description** | **String** | Description of the rate plan charge. | [optional] 
+**discount_amount** | **Number** | The amount of the discount. | [optional] 
+**discount_apply_details** | [**[DiscountApplyDetail]**](DiscountApplyDetail.md) | Container for the application details about a discount rate plan charge.   Only discount rate plan charges have values in this field.  | [optional] 
+**discount_class** | **String** | The class that the discount belongs to. The discount class defines the order in which discount rate plan charges are applied.  For more information, see [Manage Discount Classes](https://knowledgecenter.zuora.com/BC_Subscription_Management/Product_Catalog/B_Charge_Models/Manage_Discount_Classes).  | [optional] 
+**discount_level** | [**DiscountLevel**](DiscountLevel.md) |  | [optional] 
+**discount_percentage** | **Number** | The amount of the discount as a percentage.  | [optional] 
+**apply_to_billing_period_partially** | **Boolean** |  | [optional] 
+**dmrc** | **Number** | The change (delta) of monthly recurring charge exists when the change in monthly recurring revenue caused by an amendment or a new subscription.  | [optional] 
+**done** | **Boolean** | A value of `true` indicates that an invoice for a charge segment has been completed. A value of `false` indicates that an invoice has not been completed for the charge segment.  | [optional] 
+**drawdown_rate** | **Number** |  | [optional] 
+**drawdown_uom** | **String** | Specifies the units to measure usage. | [optional] 
+**dtcv** | **Number** | After an amendment or an AutomatedPriceChange event, `dtcv` displays the change (delta) for the total contract value (TCV) amount for this charge, compared with its previous value with recurring charge types.  | [optional] 
+**effective_end_date** | **String** |  | [optional] 
+**effective_start_date** | **String** |  | [optional] 
+**end_date_condition** | [**EndDateCondition**](EndDateCondition.md) |  | [optional] 
+**included_units** | **Number** |  | [optional] 
+**input_argument_id** | **String** |  | [optional] 
+**is_committed** | **Boolean** |  | [optional] 
+**is_prepaid** | **Boolean** |  | [optional] 
+**is_rollover** | **Boolean** |  | [optional] 
+**mrr** | **Number** |  | [optional] 
+**original_order_date** | **String** |  | [optional] 
+**overage_price** | **Number** |  | [optional] 
+**prepaid_operation_type** | **String** |  | [optional] 
+**prepaid_quantity** | **Number** |  | [optional] 
+**prepaid_total_quantity** | **Number** |  | [optional] 
+**prepaid_uom** | **String** | Specifies the units to measure usage. | [optional] 
+**quantity** | **Number** |  | [optional] 
+**price** | **Number** |  | [optional] 
+**price_change_option** | [**PriceChangeOption**](PriceChangeOption.md) |  | [optional] 
+**price_increase_percentage** | **Number** |  | [optional] 
+**pricing_summary** | **String** |  | [optional] 
+**original_list_price** | **Number** |  | [optional] 
+**processed_through_date** | **String** |  | [optional] 
+**rollover_apply** | **String** |  | [optional] 
+**rollover_period_length** | **Number** |  | [optional] 
+**rollover_periods** | **Number** |  | [optional] 
+**proration_option** | **String** |  | [optional] 
+**segment** | **Number** |  | [optional] 
+**specific_end_date** | **String** |  | [optional] 
+**subscription_charge_interval_pricing** | [**[IntervalPricing]**](IntervalPricing.md) |  | [optional] 
+**tcv** | **Number** |  | [optional] 
+**tiers** | [**[RatePlanChargeTier]**](RatePlanChargeTier.md) |  | [optional] 
+**trigger_date** | **String** |  | [optional] 
+**billing_period_alignment** | [**BillingPeriodAlignment**](BillingPeriodAlignment.md) |  | [optional] 
+**trigger_event** | [**TriggerEvent**](TriggerEvent.md) |  | [optional] 
+**up_to_periods** | **Number** |  | [optional] 
+**up_to_periods_type** | [**UpToPeriodsType**](UpToPeriodsType.md) |  | [optional] 
+**validity_period_type** | [**ValidityPeriodType**](ValidityPeriodType.md) |  | [optional] 
+**sales_price** | **Number** |  | [optional] 
+**accounting_code** | **String** |  | [optional] 
+**revenue_recognition_code** | **String** |  | [optional] 
+**rev_rec_trigger_condition** | **String** |  | [optional] 
+**estimated_end_date** | **String** |  | [optional] 
+**estimated_start_date** | **String** |  | [optional] 
+**taxable** | **Boolean** |  | [optional] 
+**tax_code** | **String** |  | [optional] 
+**tax_mode** | **String** |  | [optional] 
+
+
+
+## Enum: CreditOptionEnum
+
+
+* `TimeBased` (value: `"TimeBased"`)
+
+* `ConsumptionBased` (value: `"ConsumptionBased"`)
+
+* `FullCreditBack` (value: `"FullCreditBack"`)
+
+
+
+
+
+## Enum: PrepaidOperationTypeEnum
+
+
+* `topup` (value: `"topup"`)
+
+* `drawdown` (value: `"drawdown"`)
+
+
+
+
+
+## Enum: RolloverApplyEnum
+
+
+* `ApplyFirst` (value: `"ApplyFirst"`)
+
+* `ApplyLast` (value: `"ApplyLast"`)
+
+
+
+

package/docs/RatePlanChargeTier.md

@@ -0,0 +1,25 @@
+# ZuoraSdkJs.RatePlanChargeTier
+
+## Properties
+
+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_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] 
+
+
+
+## Enum: PriceFormatEnum
+
+
+* `FlatFee` (value: `"FlatFee"`)
+
+* `PerUnit` (value: `"PerUnit"`)
+
+
+
+

package/docs/RatePlanFeatureOverride.md

@@ -0,0 +1,12 @@
+# ZuoraSdkJs.RatePlanFeatureOverride
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**custom_fields** | **{String: Object}** | A container for custom fields of the feature.  | [optional] 
+**description** | **String** | A description of the feature. | [optional] 
+**feature_id** | **String** | Internal identifier of the feature in the product catalog.  | [optional] 
+**id** | **String** | Internal identifier of the rate plan feature override.  | [optional] 
+
+

package/docs/RatePlanObjectCustomFields.md

@@ -0,0 +1,8 @@
+# ZuoraSdkJs.RatePlanObjectCustomFields
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

package/docs/RatePlanOverride.md

@@ -0,0 +1,20 @@
+# ZuoraSdkJs.RatePlanOverride
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**charge_overrides** | [**[GetChargeOverride]**](GetChargeOverride.md) | List of charges associated with the rate plan.  | [optional] 
+**clearing_existing_features** | **Boolean** | Specifies whether all features in the rate plan will be cleared.  | [optional] 
+**custom_fields** | **{String: Object}** | Container for custom fields of the Rate Plan object. The custom fields of the Rate Plan object are used when rate plans are subscribed.  | [optional] 
+**externally_managed_plan_id** | **String** | Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.  | [optional] 
+**new_rate_plan_id** | **String** | Internal identifier of the rate plan.  | [optional] 
+**product_rate_plan_id** | **String** | Internal identifier of the product rate plan that the rate plan is based on.  | 
+**product_rate_plan_number** | **String** | Number of a product rate plan for this subscription.  | [optional] 
+**subscription_product_features** | [**[RatePlanFeatureOverride]**](RatePlanFeatureOverride.md) | List of features associated with the rate plan. The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:  * If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.  * If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.      | [optional] 
+**unique_token** | **String** | Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.  For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.  | [optional] 
+**subscription_rate_plan_number** | **String** | Number of a subscription rate plan for this subscription.  | [optional] 
+**is_from_external_catalog** | **Boolean** | Indicates whether the rate plan is created from the Zuora product catalog or from an external product catalog.  **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.  | [optional] 
+**rate_plan_name** | **String** | Name of the standalone rate plan.  **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.  | [optional] 
+
+

package/docs/RatePlanUpdate.md

@@ -0,0 +1,20 @@
+# ZuoraSdkJs.RatePlanUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**charge_updates** | [**[ChargeUpdate]**](ChargeUpdate.md) | Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action.  | [optional] 
+**clearing_existing_features** | **Boolean** | Specifies whether all features in the rate plan will be cleared.  | [optional] 
+**custom_fields** | **{String: Object}** | Container for custom fields of the Rate Plan object. The custom fields of the Rate Plan object are used when rate plans are subscribed.  | [optional] 
+**externally_managed_plan_id** | **String** | Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.  | [optional] 
+**new_rate_plan_id** | **String** | Internal identifier of the updated rate plan in the new subscription version.  | [optional] 
+**product_rate_plan_number** | **String** | Number of a product rate plan for this subscription.  | [optional] 
+**product_rate_plan_id** | **String** | ID of a product rate plan for this subscription.  | [optional] 
+**rate_plan_id** | **String** | Internal identifier of the rate plan that was updated. It can be the latest version or any history version id.  | [optional] 
+**specific_update_date** | **String** |  The date when the Update Product order action takes effect. This field is only applicable if there is already a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd.  See [Update a Product on Subscription with Future-dated Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates) for more information about this feature.  | [optional] 
+**subscription_product_features** | [**[RatePlanFeatureOverride]**](RatePlanFeatureOverride.md) | List of features associated with the rate plan. The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows: * If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared. * If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.  | [optional] 
+**subscription_rate_plan_number** | **String** | Number of a rate plan for this subscription.  | [optional] 
+**unique_token** | **String** | A unique string to represent the rate plan in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan and use that token in future order actions.  | [optional] 
+
+

package/docs/RatePlansApi.md

@@ -0,0 +1,75 @@
+# ZuoraSdkJs.RatePlansApi
+
+All URIs are relative to *https://rest.zuora.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**getRatePlan**](RatePlansApi.md#getRatePlan) | **GET** /v1/rateplans/{ratePlanId} | Retrieve a rate plan
+
+
+
+## getRatePlan
+
+> GetOrderActionRatePlanResponse getRatePlan(rate_plan_id, opts)
+
+Retrieve a rate plan
+
+ Retrieves the detailed information about a specific subscription rate plan.  * If you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled, this operation retrieves information about a subscription rate plan and the related order that has amended the rate plan.  * If you have the [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) feature enabled, this operation retrieves information about a subscription rate plan and the related order and amendment that have amended the rate plan.  * If you are an existing Zuora Subscribe and Amend customer, this operation retrieves information about a subscription rate plan and the related amendment that has amended the rate plan.  **Note:** Orders is now generally available as of Zuora Billing Release 284 (August 2020). If you are an existing Zuora Subscribe and Amend customer and want to adopt Orders, see [What is Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization#What_is_Orders_Harmonization.3F) and join the [Orders Harmonization community group](https://community.zuora.com/t5/Orders-Harmonization/gp-p/Orders-Harmonization) for more information. If you want to enable Orders, submit a request at [Zuora Global Support](https://support.zuora.com/).  **Note:** You can only retrieve information about the following order actions:  * `addProduct` * `updateProduct` * `removeProduct` * `changePlan` 
+
+### 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.RatePlansApi();
+let rate_plan_id = "rate_plan_id_example"; // String | The ID of the subscription rate plan to be retrieved.
+let opts = {
+  'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
+  'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
+  'authorization': "authorization_example", // String | The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken). 
+  'zuora_track_id': "zuora_track_id_example", // String | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.  The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). 
+  'zuora_entity_ids': "zuora_entity_ids_example", // String | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. 
+  'get_prev_rate_plan_version': true, // Boolean | Specify if you want to retrieve the previous version id of the rate plan.  *  `true` - Returns the previous version id of the subscription rate plan. *  `false` - Returns the previous version id of the subscription rate plan in the request.
+  '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. 
+};
+apiInstance.getRatePlan(rate_plan_id, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rate_plan_id** | **String**| The ID of the subscription rate plan to be retrieved. | 
+ **accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.  | [optional] 
+ **content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.  | [optional] 
+ **authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).  | [optional] 
+ **zuora_track_id** | **String**| A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.  The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`).  | [optional] 
+ **zuora_entity_ids** | **String**| An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  | [optional] 
+ **get_prev_rate_plan_version** | **Boolean**| Specify if you want to retrieve the previous version id of the rate plan.  *  `true` - Returns the previous version id of the subscription rate plan. *  `false` - Returns the previous version id of the subscription rate plan in the request. | [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] 
+
+### Return type
+
+[**GetOrderActionRatePlanResponse**](GetOrderActionRatePlanResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

package/docs/RatingGroup.md

@@ -0,0 +1,16 @@
+# ZuoraSdkJs.RatingGroup
+
+## Enum
+
+
+* `ByBillingPeriod` (value: `"ByBillingPeriod"`)
+
+* `ByUsageStartDate` (value: `"ByUsageStartDate"`)
+
+* `ByUsageRecord` (value: `"ByUsageRecord"`)
+
+* `ByUsageUpload` (value: `"ByUsageUpload"`)
+
+* `ByGroupId` (value: `"ByGroupId"`)
+
+

package/docs/RatingGroupsOperatorType.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.RatingGroupsOperatorType
+
+## Enum
+
+
+* `Sum` (value: `"Sum"`)
+
+* `Max` (value: `"Max"`)
+
+

package/docs/RatingPropertiesOverride.md

@@ -0,0 +1,11 @@
+# ZuoraSdkJs.RatingPropertiesOverride
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_prorate_partial_month** | **Boolean** | Indicates whether to prorate the charge for the partial month.  | [optional] 
+**proration_unit** | [**ChargeProrationRuleProrationUnit**](ChargeProrationRuleProrationUnit.md) |  | [optional] 
+**days_in_month** | [**ChargeProrationRuleDaysInMonth**](ChargeProrationRuleDaysInMonth.md) |  | [optional] 
+
+

package/docs/ReconcileRefundRequest.md

@@ -0,0 +1,13 @@
+# ZuoraSdkJs.ReconcileRefundRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | [**ReconcileRefundRequestAction**](ReconcileRefundRequestAction.md) |  | [optional] 
+**action_date** | **String** | The date and time of the refund reconciliation action, in `yyyy-mm-dd hh:mm:ss` format.  | [optional] 
+**gateway_reconciliation_reason** | **String** | The reason of gateway reconciliation.  | [optional] 
+**gateway_reconciliation_status** | **String** | The status of gateway reconciliation.  | [optional] 
+**payout_id** | **String** | The payout ID of the refund from the gateway side.  | [optional] 
+
+

package/docs/ReconcileRefundRequestAction.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.ReconcileRefundRequestAction
+
+## Enum
+
+
+* `settle` (value: `"settle"`)
+
+* `reject` (value: `"reject"`)
+
+

package/docs/RecurringDeliveryPricingOverride.md

@@ -0,0 +1,12 @@
+# ZuoraSdkJs.RecurringDeliveryPricingOverride
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price_change_option** | [**PriceChangeOption**](PriceChangeOption.md) |  | [optional] 
+**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] 
+**delivery_schedule** | [**DeliveryScheduleParams**](DeliveryScheduleParams.md) |  | [optional] 
+**list_price** | **Number** | Price of the charge in each recurring period.  | [optional] 
+
+

package/docs/RecurringDeliveryPricingUpdate.md

@@ -0,0 +1,12 @@
+# ZuoraSdkJs.RecurringDeliveryPricingUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price_change_option** | [**PriceChangeOption**](PriceChangeOption.md) |  | [optional] 
+**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] 
+**delivery_schedule** | [**DeliveryScheduleParams**](DeliveryScheduleParams.md) |  | [optional] 
+**list_price** | **Number** |  | [optional] 
+
+

package/docs/RecurringFlatFeePricingOverride.md

@@ -0,0 +1,14 @@
+# ZuoraSdkJs.RecurringFlatFeePricingOverride
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price_change_option** | [**PriceChangeOption**](PriceChangeOption.md) |  | [optional] 
+**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] 
+**list_price** | **Number** | Price of the charge in each recurring period.  | [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.  **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.  | [optional] 
+**list_price_base** | [**ChargeListPriceBase**](ChargeListPriceBase.md) |  | [optional] 
+**specific_list_price_base** | **Number** | The number of months for the list price base of the charge. This field is required if you set the value of the `listPriceBase` field to `Per_Specific_Months`.  **Note**:    - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.   - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.                | [optional] 
+
+

package/docs/RecurringFlatFeePricingUpdate.md

@@ -0,0 +1,12 @@
+# ZuoraSdkJs.RecurringFlatFeePricingUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price_change_option** | [**PriceChangeOption**](PriceChangeOption.md) |  | [optional] 
+**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] 
+**list_price** | **Number** |  | [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/RecurringPerUnitPricingOverride.md

@@ -0,0 +1,16 @@
+# ZuoraSdkJs.RecurringPerUnitPricingOverride
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price_change_option** | [**PriceChangeOption**](PriceChangeOption.md) |  | [optional] 
+**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] 
+**list_price** | **Number** | Per-unit price of the charge in each recurring period.  | [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.  **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.  | [optional] 
+**uom** | **String** | Unit of measure of the standalone charge.  **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.  | [optional] 
+**list_price_base** | [**ChargeListPriceBase**](ChargeListPriceBase.md) |  | [optional] 
+**quantity** | **Number** | Number of units purchased.  | [optional] 
+**specific_list_price_base** | **Number** | The number of months for the list price base of the charge. This field is required if you set the value of the `listPriceBase` field to `Per_Specific_Months`.  **Note**:    - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.   - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.                | [optional] 
+
+

package/docs/RecurringPerUnitPricingUpdate.md

@@ -0,0 +1,13 @@
+# ZuoraSdkJs.RecurringPerUnitPricingUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price_change_option** | [**PriceChangeOption**](PriceChangeOption.md) |  | [optional] 
+**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] 
+**list_price** | **Number** |  | [optional] 
+**quantity** | **Number** |  | [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/RecurringTieredPricingOverride.md

@@ -0,0 +1,15 @@
+# ZuoraSdkJs.RecurringTieredPricingOverride
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price_change_option** | [**PriceChangeOption**](PriceChangeOption.md) |  | [optional] 
+**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] 
+**list_price_base** | [**ChargeListPriceBase**](ChargeListPriceBase.md) |  | [optional] 
+**quantity** | **Number** | Number of units purchased.  | [optional] 
+**specific_list_price_base** | **Number** | The number of months for the list price base of the charge. This field is required if you set the value of the `listPriceBase` field to `Per_Specific_Months`.  **Note**:    - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.   - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.                | [optional] 
+**tiers** | [**[ChargeTier]**](ChargeTier.md) | List of cumulative pricing tiers in the charge.  | [optional] 
+**uom** | **String** | Unit of measure of the standalone charge.  **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.  | [optional] 
+
+

package/docs/RecurringTieredPricingUpdate.md

@@ -0,0 +1,12 @@
+# ZuoraSdkJs.RecurringTieredPricingUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price_change_option** | [**PriceChangeOption**](PriceChangeOption.md) |  | [optional] 
+**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] 
+**quantity** | **Number** |  | [optional] 
+**tiers** | [**[ChargeTier]**](ChargeTier.md) |  | [optional] 
+
+

package/docs/RecurringVolumePricingOverride.md

@@ -0,0 +1,15 @@
+# ZuoraSdkJs.RecurringVolumePricingOverride
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price_change_option** | [**PriceChangeOption**](PriceChangeOption.md) |  | [optional] 
+**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] 
+**list_price_base** | [**ChargeListPriceBase**](ChargeListPriceBase.md) |  | [optional] 
+**quantity** | **Number** | Number of units purchased.  | [optional] 
+**specific_list_price_base** | **Number** | The number of months for the list price base of the charge. This field is required if you set the value of the `listPriceBase` field to `Per_Specific_Months`.  **Note**:    - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.   - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.                | [optional] 
+**tiers** | [**[ChargeTier]**](ChargeTier.md) | List of variable pricing tiers in the charge.  | [optional] 
+**uom** | **String** | Unit of measure of the standalone charge.  **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.  | [optional] 
+
+

package/docs/RecurringVolumePricingUpdate.md

@@ -0,0 +1,12 @@
+# ZuoraSdkJs.RecurringVolumePricingUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price_change_option** | [**PriceChangeOption**](PriceChangeOption.md) |  | [optional] 
+**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] 
+**quantity** | **Number** |  | [optional] 
+**tiers** | [**[ChargeTier]**](ChargeTier.md) |  | [optional] 
+
+

package/docs/Refund.md

@@ -0,0 +1,48 @@
+# ZuoraSdkJs.Refund
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment or credit memo.  | [optional] 
+**amount** | **Number** | The total amount of the refund.  | [optional] 
+**cancelled_on** | **String** | The date and time when the refund was cancelled, in `yyyy-mm-dd hh:mm:ss` format.  | [optional] 
+**comment** | **String** | Comments about the refund.  | [optional] 
+**created_by_id** | **String** | The ID of the Zuora user who created the refund.  | [optional] 
+**created_date** | **String** | The date and time when the refund was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.  | [optional] 
+**credit_memo_id** | **String** | The ID of the credit memo that is refunded.  | [optional] 
+**finance_information** | [**GetRefundCreditMemoFinanceInformation**](GetRefundCreditMemoFinanceInformation.md) |  | [optional] 
+**gateway_id** | **String** | The ID of the gateway instance that processes the refund.  | [optional] 
+**payment_gateway_number** | **String** |  | [optional] 
+**gateway_reconciliation_reason** | **String** | The reason of gateway reconciliation.  | [optional] 
+**gateway_reconciliation_status** | **String** | The status of gateway reconciliation.  | [optional] 
+**gateway_response** | **String** | The message returned from the payment gateway for the refund. This message is gateway-dependent.  | [optional] 
+**gateway_response_code** | **String** | The code returned from the payment gateway for the refund. This code is gateway-dependent.  | [optional] 
+**gateway_state** | [**GatewayState**](GatewayState.md) |  | [optional] 
+**id** | **String** | The ID of the refund.  | [optional] 
+**marked_for_submission_on** | **String** | The date and time when a refund was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.  | [optional] 
+**method_type** | [**PaymentMethodType**](PaymentMethodType.md) |  | [optional] 
+**number** | **String** | The unique identification number of the refund.  | [optional] 
+**payment_id** | **String** | The ID of the payment that is refunded.  | [optional] 
+**payment_number** | **String** |  | [optional] 
+**payment_method_id** | **String** | The unique ID of the payment method that the customer used to make the refund.  | [optional] 
+**payment_method_snapshot_id** | **String** | The unique ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction.  | [optional] 
+**payout_id** | **String** | The payout ID of the refund from the gateway side.  | [optional] 
+**reason_code** | **String** | A code identifying the reason for the transaction.  | [optional] 
+**reference_id** | **String** | The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.  | [optional] 
+**refund_date** | **String** | The date when the refund takes effect, in `yyyy-mm-dd` format. For example, 2017-03-01.  | [optional] 
+**refund_transaction_time** | **String** | The date and time when the refund was issued, in `yyyy-mm-dd hh:mm:ss` format.  | [optional] 
+**second_refund_reference_id** | **String** | The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.  | [optional] 
+**settled_on** | **String** | The date and time when the refund was settled in the payment processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by the Spectrum gateway only and not applicable to other gateways.  | [optional] 
+**soft_descriptor** | **String** | A payment gateway-specific field that maps Zuora to other gateways.  | [optional] 
+**soft_descriptor_phone** | **String** | A payment gateway-specific field that maps Zuora to other gateways.  | [optional] 
+**status** | [**RefundStatus**](RefundStatus.md) |  | [optional] 
+**submitted_on** | **String** | The date and time when the refund was submitted, in `yyyy-mm-dd hh:mm:ss` format.  | [optional] 
+**organization_label** | **String** |  | [optional] 
+**type** | [**RefundType**](RefundType.md) |  | [optional] 
+**refund_transaction_type** | [**RefundTransactionType**](RefundTransactionType.md) |  | [optional] 
+**updated_by_id** | **String** | The ID of the Zuora user who last updated the refund.  | [optional] 
+**updated_date** | **String** | The date and time when the refund was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.  | [optional] 
+**write_off_results** | [**WriteOffResults**](WriteOffResults.md) |  | [optional] 
+
+

package/docs/RefundCreditMemoItemRequest.md

@@ -0,0 +1,11 @@
+# ZuoraSdkJs.RefundCreditMemoItemRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Number** | The amount of the refund on the specific item.  | 
+**credit_memo_item_id** | **String** | The ID of the credit memo item that is refunded.  | [optional] 
+**credit_tax_item_id** | **String** | The ID of the credit memo taxation item that is refunded.  | [optional] 
+
+