zuora-sdk-js 3.14.0 → 3.15.0

package/docs/GetCommitmentResponse.md

@@ -0,0 +1,60 @@
+# ZuoraSdkJs.GetCommitmentResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | ID of the commitment. | [optional] 
+**status** | [**CommitmentStatusEnum**](CommitmentStatusEnum.md) |  | [optional] 
+**version** | **Number** | Version of the commitment. | [optional] 
+**currency** | **String** | Currency of the commitment. | [optional] 
+**start_date** | **String** | Start date of the commitment. | [optional] 
+**end_date** | **String** | End date of the commitment. | [optional] 
+**total_amount** | **Number** | Total committed amount. | [optional] 
+**order_number** | **String** | The number of the order. | [optional] 
+**order_id** | **String** | The ID of the order. | [optional] 
+**account_id** | **String** | The ID of the commitment owner account. | [optional] 
+**account_number** | **String** | Use this field to assign an existing account as the owner of an Commitment. | [optional] 
+**commitment_number** | **String** | The number for the commitment. | [optional] 
+**name** | **String** | The name of the commitment. | [optional] 
+**type** | [**CommitmentTypeEnum**](CommitmentTypeEnum.md) |  | [optional] 
+**description** | **String** | The description about this commitment. | [optional] 
+**priority** | **Number** | The priority of the commitment. It defines the evaluation order of the commitment.  The lower the number, the higher the priority. When two commitments have the same priority,  the one with the earlier created time will be evaluated first. | [optional] 
+**association_rules** | [**[AssociationRule]**](AssociationRule.md) |  | [optional] 
+**eligible_account_conditions** | [**EligibleAccountCondition**](EligibleAccountCondition.md) |  | [optional] 
+**eligible_charge_conditions** | [**EligibleChargeCondition**](EligibleChargeCondition.md) |  | [optional] 
+**period_alignment_option** | [**AlignmentOptionEnum**](AlignmentOptionEnum.md) |  | [optional] 
+**specific_period_alignment_date** | **String** | The specific date for period alignment, required if periodAlignmentOption is SpecificDate. | [optional] 
+**custom_fields** | **{String: Object}** | Container for custom fields of a Commitment object. | [optional] 
+**ace_id** | **Number** | Account code entity Id | [optional] 
+**adjustment_liability_accounting_code** | **String** | The accounting code on the Commitment object for customers using [Zuora Order - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue).  | [optional] 
+**adjustment_revenue_accounting_code** | **String** | The accounting code on the Commitment object for customers using [Zuora Order - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue).  | [optional] 
+**contract_asset_accounting_code** | **String** | The accounting code on the Commitment object for customers using [Zuora Order - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue).  | [optional] 
+**contract_liability_accounting_code** | **String** | The accounting code on the Commitment object for customers using [Zuora Order - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue).  | [optional] 
+**contract_recognized_revenue_accounting_code** | **String** | The accounting code on the Commitment object for customers using [Zuora Order - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue).  | [optional] 
+**deferred_revenue_accounting_code** | **String** | The deferred revenue accounting code for the Commitment.  | [optional] 
+**exclude_item_billing_from_revenue_accounting** | **Boolean** | The flag to exclude Commitment related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.   **Note**: This field is only available if you have the Order - Revenue Integration feature enabled.   | [optional] 
+**is_allocation_eligible** | **Boolean** | This field is used to identify if the charge is allocation eligible in revenue recognition.  | [optional] 
+**is_unbilled** | **Boolean** | This field is used to dictate how to perform the accounting during revenue recognition.  | [optional] 
+**recognized_revenue_accounting_code** | **String** | The recognized revenue accounting code for the Commitment.  | [optional] 
+**revenue_recognition_rule** | **String** | The Revenue Recognition rule for the Commitment.  | [optional] 
+**unbilled_receivables_accounting_code** | **String** | The accounting code on the Commitment object for customers using [Zuora Order - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue).  | [optional] 
+**revenue_recognition_timing** | **String** | The revenue recognition timing for the Commitment period.  | [optional] 
+**revenue_amortization_method** | **String** | The revenue amortization method for the Commitment period.  | [optional] 
+**account_receivable_accounting_code** | **String** | The accounting code on the Commitment period object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration). | [optional] 
+**taxable** | **Boolean** | Determines whether a transaction line item in the billing document is taxable. If this field is set to true, both the fields taxCode and taxMode are required.  | [optional] 
+**tax_code** | **String** | The identifier or set of characters assigned to a transaction line item to determine the applicable tax rate and calculate the tax amount. This field is available when the field 'taxable' is set to true.  | [optional] 
+**tax_mode** | **String** | Determines whether the tax amount is inclusive or exclusive for the transaction line item. This field is available when the field 'taxable' is set to true.  | [optional] 
+
+
+
+## Enum: TaxModeEnum
+
+
+* `TaxInclusive` (value: `"TaxInclusive"`)
+
+* `TaxExclusive` (value: `"TaxExclusive"`)
+
+
+
+

package/docs/GetOrderChargeRemoval.md

@@ -0,0 +1,11 @@
+# ZuoraSdkJs.GetOrderChargeRemoval
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**charge_number** | **String** | The number of the charge that was removed.  | [optional] 
+**description** | **String** | Description of why the charge was removed.  | [optional] 
+**unique_token** | **String** | A unique string to represent the charge removal in the order.  | [optional] 
+
+

package/docs/GetProductRatePlanChargeResponse.md

@@ -27,6 +27,8 @@ Name | Type | Description | Notes
 **discount_level** | [**DiscountLevel**](DiscountLevel.md) |  | [optional] 
 **drawdown_rate** | **Number** | **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.   The [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). Must be a positive number (>0). | [optional] 
 **drawdown_uom** | **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.  Unit of measurement for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). | [optional] 
+**eligible_account_conditions** | [**ExtendedGroupCondition**](ExtendedGroupCondition.md) | Conditions that determine which accounts are eligible for this calculated charge. Only applicable when `ChargeModel` is `Calculated`. | [optional] 
+**eligible_charge_conditions** | [**ExtendedGroupCondition**](ExtendedGroupCondition.md) | Conditions that determine which charges are eligible to be calculated by this charge. Only applicable when `ChargeModel` is `Calculated`. | [optional] 
 **end_date_condition** | [**EndDateConditionProductRatePlanChargeRest**](EndDateConditionProductRatePlanChargeRest.md) |  | [optional] 
 **exclude_item_billing_from_revenue_accounting** | **Boolean** | The flag to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.   **Notes**:    - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.   - This field is only available if you have the Billing - Revenue Integration feature enabled.  | [optional] 
 **exclude_item_booking_from_revenue_accounting** | **Boolean** | The flag to exclude the related rate plan charges and order line items from revenue accounting.   **Notes**:    - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.   - This field is only available if you have the Billing - Revenue Integration feature enabled.  | [optional] 

package/docs/GetSubscriptionRatePlanChargesWithAllSegments.md

@@ -115,7 +115,7 @@ Name | Type | Description | Notes
 **is_price_negotiated** | **Boolean** | Indicates whether the charge uses negotiated pricing. **Note**: This field is only available when NegotiatedPriceTable permission enabled.  | [optional] 
 **is_last_segment** | **Boolean** | Indicates whether the charge segment is the last segment.  | [optional] 
 **optional** | **Boolean** | Indicates whether this charge is optional in a bundle rate plan. Optional charges can be added to or removed from subscriptions using the UpdateProduct order action.  **Note:** This field is only available when EnableHardBundle permission enabled.  | [optional] 
-**status** | **String** | The status of the charge. Possible values: - `removeDirectly`: The charge has been removed via UpdateProduct order action. - `deleteWithRatePlan`: The charge has been deleted with the rate plan.  **Note:** This field is only available when EnableHardBundle permission enabled.  | [optional] 
+**status** | **String** | The status of the charge. Possible values: - `removeDirectly`: The charge has been removed via UpdateProduct order action. Please note this value is deprecated and will be removed in future releases. - `deleteWithRatePlan`: The charge has been deleted with the rate plan. Please note this value is deprecated and will be removed in future releases. - `removedDirectly`: The charge has been removed via UpdateProduct order action. - `removedWithRatePlan`: The charge has been removed with the rate plan.    **Note:** This field is only available when EnableHardBundle permission enabled.  | [optional] 
 
 
 
@@ -170,6 +170,10 @@ Name | Type | Description | Notes
 
 * `deleteWithRatePlan` (value: `"deleteWithRatePlan"`)
 
+* `removedDirectly` (value: `"removedDirectly"`)
+
+* `removedWithRatePlan` (value: `"removedWithRatePlan"`)
+
 
 
 

package/docs/GetSubscriptionResponse.md

@@ -80,5 +80,6 @@ Name | Type | Description | Notes
 **net_total_contracted_value** | **Number** | Total contracted value of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts.  | [optional] 
 **account_owner_details** | [**AccountBasicInfo**](AccountBasicInfo.md) |  | [optional] 
 **invoice_owner_account_details** | [**AccountBasicInfo**](AccountBasicInfo.md) |  | [optional] 
+**ramp** | [**SubscriptionRampResponse**](SubscriptionRampResponse.md) |  | [optional] 
 
 

package/docs/ListCommitmentPeriodOutput.md

@@ -0,0 +1,20 @@
+# ZuoraSdkJs.ListCommitmentPeriodOutput
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start_date** | **String** | Start date of the commitment period. | [optional] 
+**end_date** | **String** | End date of the commitment period. | [optional] 
+**is_prorated** | **Boolean** | Indicates if the period is prorated. | [optional] 
+**amount** | **Number** | The committed amount of the each commitment period | [optional] 
+**id** | **String** | ID of the commitment period. | [optional] 
+**commitment_id** | **String** | ID of the commitment. | [optional] 
+**commitment_number** | **String** | The number of the commitment. | [optional] 
+**version** | **Number** | Version of the commitment period. | [optional] 
+**type** | [**CommitmentTypeEnum**](CommitmentTypeEnum.md) |  | [optional] 
+**priority** | **Number** | Priority of the commitment. | [optional] 
+**currency** | **String** | Currency of the commitment. | [optional] 
+**status** | [**PeriodStatusResponse**](PeriodStatusResponse.md) |  | [optional] 
+
+

package/docs/ListCommitmentScheduleOutput.md

@@ -0,0 +1,20 @@
+# ZuoraSdkJs.ListCommitmentScheduleOutput
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | ID of the commitment schedule. | [optional] 
+**commitment_id** | **String** | ID of the commitment. | [optional] 
+**commitment_number** | **String** | The number of the commitment. | [optional] 
+**version** | **Number** | Version of the commitment schedule. | [optional] 
+**start_date** | **String** | Start date of the commitment schedule. | [optional] 
+**end_date** | **String** | End date of the commitment schedule. | [optional] 
+**total_amount** | **Number** | The total amount of the commitment schedule. | [optional] 
+**amount** | **Number** | The non prorated actual amount of the schedule | [optional] 
+**amount_base** | [**AmountBase**](AmountBase.md) |  | [optional] 
+**period_type** | [**PeriodFrequencyEnum**](PeriodFrequencyEnum.md) |  | [optional] 
+**specific_period_length** | **Number** | The specific length of the period, required if periodType is SpecificMonths. | [optional] 
+**status** | [**ScheduleStatusOutput**](ScheduleStatusOutput.md) |  | [optional] 
+
+

package/docs/ListCommitmentsOutput.md

@@ -0,0 +1,12 @@
+# ZuoraSdkJs.ListCommitmentsOutput
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Number** | Total number of commitments returned. | [optional] 
+**page** | **Number** | Current page number. | [optional] 
+**page_size** | **Number** | Number of commitments per page. | [optional] 
+**commitments** | [**[GetCommitmentResponse]**](GetCommitmentResponse.md) | List of commitments. | [optional] 
+
+

package/docs/ListPeriods200Response.md

@@ -0,0 +1,12 @@
+# ZuoraSdkJs.ListPeriods200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**periods** | [**[ListCommitmentPeriodOutput]**](ListCommitmentPeriodOutput.md) | A list of commitment period objects. | [optional] 
+**total** | **Number** | Total number of periods available for the given commitment/Total commitments for given account. | [optional] 
+**page** | **Number** | Current page number. | [optional] 
+**page_size** | **Number** | Number of results returned per page. | [optional] 
+
+

package/docs/ListSchedulesByCommitment200Response.md

@@ -0,0 +1,12 @@
+# ZuoraSdkJs.ListSchedulesByCommitment200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**schedules** | [**[ListCommitmentScheduleOutput]**](ListCommitmentScheduleOutput.md) | A list of commitment schedule objects. | [optional] 
+**total** | **Number** | Total number of schedules available for the given commitment. | [optional] 
+**page** | **Number** | Current page number. | [optional] 
+**page_size** | **Number** | Number of results returned per page. | [optional] 
+
+

package/docs/OrderActionRatePlanUpdate.md

@@ -4,7 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**charge_updates** | [**[OrderActionRatePlanChargeUpdate]**](OrderActionRatePlanChargeUpdate.md) |  | [optional] 
+**charge_updates** | [**[OrderActionRatePlanChargeUpdate]**](OrderActionRatePlanChargeUpdate.md) | Array of charge updates in the UpdateProduct order action.  | [optional] 
+**charge_overrides** | [**[GetChargeOverride]**](GetChargeOverride.md) | Array of charge overrides for the UpdateProduct order action. Each item specifies a charge that was added to the bundle rate plan.  **Note:** This field is only available if you have the Hard Bundle feature enabled.  | [optional] 
+**charge_removals** | [**[GetOrderChargeRemoval]**](GetOrderChargeRemoval.md) | Array of charge removals for the UpdateProduct order action. Each item specifies an optional charge that was removed from the bundle rate plan.  **Note:** This field is only available if you have the Hard Bundle feature enabled.  | [optional] 
 **custom_fields** | **{String: Object}** | Container for custom fields of a Rate Plan object.  | [optional] 
 **new_rate_plan_id** | **String** | Internal identifier of the updated rate plan in the new subscription version. | [optional] 
 **rate_plan_id** | **String** | Internal identifier of the rate plan that was updated.  | [optional] 

package/docs/OrderActionUpdateProduct.md

@@ -5,8 +5,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **charge_updates** | [**[ChargeUpdate]**](ChargeUpdate.md) | Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action.  | [optional] 
-**charge_removals** | [**[ChargeRemoval]**](ChargeRemoval.md) | Array of the JSON objects containing the information for a charge removal in the `updateProduct` type of order action. Each item specifies a charge to be removed from the bundle rate plan.  **Note:** This field requires the EnableHardBundle permission to be enabled.  | [optional] 
-**charge_overrides** | [**[ChargeOverride]**](ChargeOverride.md) | Array of charge overrides for the UpdateProduct order action. Each item specifies a charge to be added or modified in the rate plan.  **Note:** This field requires the EnableHardBundle permission to be enabled. | [optional] 
+**charge_removals** | [**[GetOrderChargeRemoval]**](GetOrderChargeRemoval.md) | Array of the JSON objects containing the information for a charge removal in the `updateProduct` type of order action. Each item specifies a charge to be removed from the bundle rate plan.  **Note:** This field requires the EnableHardBundle permission to be enabled.  | [optional] 
+**charge_overrides** | [**[GetChargeOverride]**](GetChargeOverride.md) | Array of charge overrides for the UpdateProduct order action. Each item specifies a charge to be added or modified in the rate plan.  **Note:** This field requires the EnableHardBundle permission to be enabled. | [optional] 
 **clearing_existing_features** | **Boolean** | Specifies whether all features in the rate plan will be cleared.  | [optional] 
 **custom_fields** | **{String: Object}** | Container for custom fields of the Rate Plan object. The custom fields of the Rate Plan object are used when rate plans are subscribed.  | [optional] 
 **externally_managed_plan_id** | **String** | Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.  | [optional] 

package/docs/PeriodBalance.md

@@ -0,0 +1,15 @@
+# ZuoraSdkJs.PeriodBalance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | ID of the commitment period. | [optional] 
+**status** | [**PeriodBalanceType**](PeriodBalanceType.md) |  | [optional] 
+**start_date** | **String** | Start date of the commitment period. | [optional] 
+**end_date** | **String** | End date of the commitment period. | [optional] 
+**balance** | **Number** | Balance amount for the commitment period. | [optional] 
+**committed_amount** | **Number** | Committed amount of the commitment period. | [optional] 
+**total_spend** | **Number** | Total amount spent during the commitment period. | [optional] 
+
+

package/docs/PeriodBalanceType.md

@@ -0,0 +1,12 @@
+# ZuoraSdkJs.PeriodBalanceType
+
+## Enum
+
+
+* `ACTIVE` (value: `"ACTIVE"`)
+
+* `EVALUATED` (value: `"EVALUATED"`)
+
+* `ACTIVE_WITH_DRAWDOWN` (value: `"ACTIVE_WITH_DRAWDOWN"`)
+
+

package/docs/PeriodFrequencyEnum.md

@@ -0,0 +1,18 @@
+# ZuoraSdkJs.PeriodFrequencyEnum
+
+## Enum
+
+
+* `Month` (value: `"Month"`)
+
+* `Quarter` (value: `"Quarter"`)
+
+* `SemiAnnual` (value: `"SemiAnnual"`)
+
+* `Year` (value: `"Year"`)
+
+* `SpecificMonths` (value: `"SpecificMonths"`)
+
+* `SinglePeriod` (value: `"SinglePeriod"`)
+
+

package/docs/PeriodStatusResponse.md

@@ -0,0 +1,14 @@
+# ZuoraSdkJs.PeriodStatusResponse
+
+## Enum
+
+
+* `Active` (value: `"Active"`)
+
+* `Canceled` (value: `"Canceled"`)
+
+* `Evaluated` (value: `"Evaluated"`)
+
+* `ActiveWithDrawdown` (value: `"ActiveWithDrawdown"`)
+
+

package/docs/ProductRatePlanCharge.md

@@ -41,6 +41,8 @@ Name | Type | Description | Notes
 **discount_level** | [**DiscountLevel**](DiscountLevel.md) |  | [optional] 
 **drawdown_rate** | **Number** | **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.   The [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). Must be a positive number (>0). | [optional] 
 **drawdown_uom** | **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.  Unit of measurement for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). | [optional] 
+**eligible_account_conditions** | [**ExtendedGroupCondition**](ExtendedGroupCondition.md) | Conditions that determine which accounts are eligible for this calculated charge. Only applicable when `ChargeModel` is `Calculated`. | [optional] 
+**eligible_charge_conditions** | [**ExtendedGroupCondition**](ExtendedGroupCondition.md) | Conditions that determine which charges are eligible to be calculated by this charge. Only applicable when `ChargeModel` is `Calculated`. | [optional] 
 **end_date_condition** | [**EndDateConditionProductRatePlanChargeRest**](EndDateConditionProductRatePlanChargeRest.md) |  | [optional] 
 **exclude_item_billing_from_revenue_accounting** | **Boolean** | The flag to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.   **Notes**:    - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.   - This field is only available if you have the Billing - Revenue Integration feature enabled.  | [optional] 
 **exclude_item_booking_from_revenue_accounting** | **Boolean** | The flag to exclude the related rate plan charges and order line items from revenue accounting.   **Notes**:    - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.   - This field is only available if you have the Billing - Revenue Integration feature enabled.  | [optional] 

package/docs/ProductRatePlanChargeTier.md

@@ -12,5 +12,7 @@ Name | Type | Description | Notes
 **price** | **Number** | The price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.  | [optional] 
 **price_format** | [**PriceFormatProductRatePlanChargeTier**](PriceFormatProductRatePlanChargeTier.md) |  | [optional] 
 **starting_unit** | **Number** | The starting number of a range of units for the tier. Required if the charge model of the product rate plan charge is `Tiered Pricing` or `Tiered with Overage Pricing`.  | [optional] 
+**minimum_amount** | **Number** | The minimum amount for this tier when used in a calculated charge. Only applicable when `ChargeModel` is `Calculated`.  | [optional] 
+**maximum_amount** | **Number** | The maximum amount for this tier when used in a calculated charge. Only applicable when `ChargeModel` is `Calculated`.  | [optional] 
 
 

package/docs/RatePlanChargeSegment.md

@@ -79,7 +79,7 @@ Name | Type | Description | Notes
 **is_price_negotiated** | **Boolean** | Indicates whether the charge uses negotiated pricing.  **Note**: This field is only available when NegotiatedPriceTable permission enabled.  | [optional] 
 **is_last_segment** | **Boolean** | Indicates whether the charge segment is the last segment.  | [optional] 
 **optional** | **Boolean** | Indicates whether this charge is optional in a bundle rate plan. Optional charges can be added to or removed from subscriptions using the UpdateProduct order action.  **Note:** This field is only available when EnableHardBundle permission enabled.  | [optional] 
-**status** | **String** | The status of the charge. Possible values: - `removeDirectly`: The charge has been removed via UpdateProduct order action. - `deleteWithRatePlan`: The charge has been deleted with the rate plan.  **Note:** This field is only available when EnableHardBundle permission enabled.  | [optional] 
+**status** | **String** | The status of the charge. Possible values: - `removeDirectly`: The charge has been removed via UpdateProduct order action. Please note this value is deprecated and will be removed in future releases. - `deleteWithRatePlan`: The charge has been deleted with the rate plan. Please note this value is deprecated and will be removed in future releases. - `removedDirectly`: The charge has been removed via UpdateProduct order action. - `removedWithRatePlan`: The charge has been removed with the rate plan.   **Note:** This field is only available when EnableHardBundle permission enabled.  | [optional] 
 
 
 
@@ -125,6 +125,10 @@ Name | Type | Description | Notes
 
 * `deleteWithRatePlan` (value: `"deleteWithRatePlan"`)
 
+* `removedDirectly` (value: `"removedDirectly"`)
+
+* `removedWithRatePlan` (value: `"removedWithRatePlan"`)
+
 
 
 

package/docs/RatePlanChargeSegmentInfo.md

@@ -79,7 +79,7 @@ Name | Type | Description | Notes
 **is_price_negotiated** | **Boolean** | Indicates whether the charge uses negotiated pricing.  **Note**: This field is only available when NegotiatedPriceTable permission enabled.  | [optional] 
 **is_last_segment** | **Boolean** | Indicates whether the charge segment is the last segment.  | [optional] 
 **optional** | **Boolean** | Indicates whether this charge is optional in a bundle rate plan. Optional charges can be added to or removed from subscriptions using the UpdateProduct order action.  **Note:** This field is only available when EnableHardBundle permission enabled.  | [optional] 
-**status** | **String** | The status of the charge. Possible values: - `removeDirectly`: The charge has been removed via UpdateProduct order action. - `deleteWithRatePlan`: The charge has been deleted with the rate plan.  **Note:** This field is only available when EnableHardBundle permission enabled.  | [optional] 
+**status** | **String** | The status of the charge. Possible values: - `removeDirectly`: The charge has been removed via UpdateProduct order action. Please note this value is deprecated and will be removed in future releases. - `deleteWithRatePlan`: The charge has been deleted with the rate plan. Please note this value is deprecated and will be removed in future releases. - `removedDirectly`: The charge has been removed via UpdateProduct order action. - `removedWithRatePlan`: The charge has been removed with the rate plan.   **Note:** This field is only available when EnableHardBundle permission enabled.  | [optional] 
 
 
 
@@ -125,6 +125,10 @@ Name | Type | Description | Notes
 
 * `deleteWithRatePlan` (value: `"deleteWithRatePlan"`)
 
+* `removedDirectly` (value: `"removedDirectly"`)
+
+* `removedWithRatePlan` (value: `"removedWithRatePlan"`)
+
 
 
 

package/docs/RatePlanUpdate.md

@@ -5,8 +5,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **charge_updates** | [**[ChargeUpdate]**](ChargeUpdate.md) | Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action.  | [optional] 
-**charge_removals** | [**[ChargeRemoval]**](ChargeRemoval.md) | Array of the JSON objects containing the information for a charge removal in the `updateProduct` type of order action. Each item specifies a charge to be removed from the bundle rate plan.  **Note:** This field requires the EnableHardBundle permission to be enabled.  | [optional] 
-**charge_overrides** | [**[ChargeOverride]**](ChargeOverride.md) | Array of charge overrides for the UpdateProduct order action. Each item specifies a charge to be added or modified in the rate plan.  **Note:** This field requires the EnableHardBundle permission to be enabled. | [optional] 
+**charge_removals** | [**[GetOrderChargeRemoval]**](GetOrderChargeRemoval.md) | Array of the JSON objects containing the information for a charge removal in the `updateProduct` type of order action. Each item specifies a charge to be removed from the bundle rate plan.  **Note:** This field requires the EnableHardBundle permission to be enabled.  | [optional] 
+**charge_overrides** | [**[GetChargeOverride]**](GetChargeOverride.md) | Array of charge overrides for the UpdateProduct order action. Each item specifies a charge to be added or modified in the rate plan.  **Note:** This field requires the EnableHardBundle permission to be enabled. | [optional] 
 **clearing_existing_features** | **Boolean** | Specifies whether all features in the rate plan will be cleared.  | [optional] 
 **custom_fields** | **{String: Object}** | Container for custom fields of the Rate Plan object. The custom fields of the Rate Plan object are used when rate plans are subscribed.  | [optional] 
 **externally_managed_plan_id** | **String** | Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.  | [optional] 

package/docs/ScheduleStatusOutput.md

@@ -0,0 +1,12 @@
+# ZuoraSdkJs.ScheduleStatusOutput
+
+## Enum
+
+
+* `Active` (value: `"Active"`)
+
+* `Canceled` (value: `"Canceled"`)
+
+* `Evaluated` (value: `"Evaluated"`)
+
+

package/docs/SubscriptionRampResponse.md

@@ -0,0 +1,14 @@
+# ZuoraSdkJs.SubscriptionRampResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The ID of the ramp. | [optional] 
+**name** | **String** | The name of the ramp. | [optional] 
+**number** | **String** | The number of the ramp. It is automatically generated by the billing system. | [optional] 
+**description** | **String** | The short description of the ramp. | [optional] 
+**intervals** | [**[RampIntervalResponse]**](RampIntervalResponse.md) | Container for the intervals that the ramp is split into in its timeline. | [optional] 
+**charges** | [**[RampChargeResponse]**](RampChargeResponse.md) | Container for the rate plan charges that are considered as part of the ramp deal. | [optional] 
+
+

package/docs/TransferPayment.md

@@ -5,5 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **account_id** | **String** | The ID of the customer account that the payment is transferred to.  Unassign a payment by setting this field to an empty string. This will automatically transfer the payment to a null account. | [optional] 
+**effective_date** | **String** | The date when the transfer payment takes effect, in `yyyy-mm-dd` format.  | [optional] 
 
 

package/docs/UpdateAccountRequest.md

@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 **additional_email_addresses** | **[String]** | A list of additional email addresses to receive email notifications. Use commas to separate email addresses. | [optional] 
 **auto_pay** | **Boolean** | Whether future payments are to be automatically billed when they are due.  | [optional] 
 **batch** | **String** | The alias name given to a batch. A string of 50 characters or less.  | [optional] 
-**bill_cycle_day** | **Number** | Sets the bill cycle day (BCD) for the charge. The BCD determines  which day of the month the customer is billed. Values: Any activated system-defined bill cycle day （`1`-`31`） | [optional] 
+**bill_cycle_day** | **Number** | Sets the bill cycle day (BCD) for the account.  - Values `1`-`31`: Sets the BCD to the specified day and configures the   account for ManualSet mode. - Value `0`: Configures the account for AutoSet mode, where the BCD will   be automatically set when the first subscription is created. Can only   be set when the account has no active subscriptions.  The `bcdSettingOption` is automatically derived from this value: `billCycleDay=0` sets `bcdSettingOption=AutoSet`, while `billCycleDay=1-31` sets `bcdSettingOption=ManualSet`. | [optional] 
 **bill_to_contact_id** | **String** | The ID of the contact that receives the bill. The contact must be   associated with the account. | [optional] 
 **bill_to_contact** | [**UpdateAccountContact**](UpdateAccountContact.md) |  | [optional] 
 **ship_to_contact_id** | **String** | The ID of the contact that receives the goods or services. The   contact must be associated with the account. | [optional] 

package/docs/UpdateProductRatePlanChargeRequest.md

@@ -38,6 +38,8 @@ Name | Type | Description | Notes
 **discount_level** | [**DiscountLevel**](DiscountLevel.md) |  | [optional] 
 **drawdown_rate** | **Number** | **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 [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). See [Fields related to Prepaid with Drawdown](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/ProductRatePlanCharge#Fields_related_to_Prepaid_with_Drawdown) for more information. | [optional] 
 **drawdown_uom** | **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.    Unit of measurement for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).  | [optional] 
+**eligible_account_conditions** | [**ExtendedGroupCondition**](ExtendedGroupCondition.md) | Conditions that determine which accounts are eligible for this calculated charge. Only applicable when `ChargeModel` is `Calculated`. | [optional] 
+**eligible_charge_conditions** | [**ExtendedGroupCondition**](ExtendedGroupCondition.md) | Conditions that determine which charges are eligible to be calculated by this charge. Only applicable when `ChargeModel` is `Calculated`. | [optional] 
 **end_date_condition** | [**EndDateConditionProductRatePlanChargeRest**](EndDateConditionProductRatePlanChargeRest.md) |  | [optional] 
 **exclude_item_billing_from_revenue_accounting** | **Boolean** | The flag to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.   **Notes**:    - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.   - This field is only available if you have the Billing - Revenue Integration feature enabled.  | [optional] [default to false]
 **exclude_item_booking_from_revenue_accounting** | **Boolean** | The flag to exclude the related rate plan charges and order line items from revenue accounting.   **Notes**:    - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.   - This field is only available if you have the Billing - Revenue Integration feature enabled.  | [optional] [default to false]

package/docs/UpsertCommitmentInput.md

@@ -28,9 +28,9 @@ Name | Type | Description | Notes
 **unbilled_receivables_accounting_code** | **String** | The accounting code on the Commitment object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
 **revenue_recognition_timing** | **String** | This field is used to dictate the type of revenue recognition timing. | [optional] 
 **revenue_amortization_method** | **String** | This field is used to dictate the type of revenue amortization method. | [optional] 
-**taxable** | **Boolean** | The flag to indicate whether the charge is taxable. If this field is set to true, both the fields `taxCode` and `taxMode` are required.  | [optional] 
-**tax_code** | **String** | The taxCode of a charge. This field is available when the field 'taxable' is set to true.  | [optional] 
-**tax_mode** | **String** | The taxMode of a charge.  Values: * `TaxExclusive` * `TaxInclusive` This field is available when the field 'taxable' is set to true.  | [optional] 
+**taxable** | **Boolean** | Determines whether a transaction line item in the billing document is taxable. If this field is set to true, both the fields taxCode and taxMode are required.  | [optional] 
+**tax_code** | **String** | The identifier or set of characters assigned to a transaction line item to determine the applicable tax rate and calculate the tax amount. This field is available when the field 'taxable' is set to true.  | [optional] 
+**tax_mode** | **String** | Determines whether the tax amount is inclusive or exclusive for the transaction line item. This field is available when the field 'taxable' is set to true.  | [optional] 
 **currency** | **String** |  | 
 **periods** | [**[UpsertCommitmentPeriodInput]**](UpsertCommitmentPeriodInput.md) |  | [optional] 
 **period_alignment_option** | [**PeriodAlignmentOptionEnum**](PeriodAlignmentOptionEnum.md) |  | [optional] 

package/docs/UpsertCreateCommitmentInput.md

@@ -27,9 +27,9 @@ Name | Type | Description | Notes
 **unbilled_receivables_accounting_code** | **String** | The accounting code on the Commitment object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
 **revenue_recognition_timing** | **String** | This field is used to dictate the type of revenue recognition timing. | [optional] 
 **revenue_amortization_method** | **String** | This field is used to dictate the type of revenue amortization method. | [optional] 
-**taxable** | **Boolean** | The flag to indicate whether the charge is taxable. If this field is set to true, both the fields `taxCode` and `taxMode` are required.  | [optional] 
-**tax_code** | **String** | The taxCode of a charge. This field is available when the field 'taxable' is set to true.  | [optional] 
-**tax_mode** | **String** | The taxMode of a charge.  Values: * `TaxExclusive` * `TaxInclusive` This field is available when the field 'taxable' is set to true.  | [optional] 
+**taxable** | **Boolean** | Determines whether a transaction line item in the billing document is taxable. If this field is set to true, both the fields taxCode and taxMode are required.  | [optional] 
+**tax_code** | **String** | The identifier or set of characters assigned to a transaction line item to determine the applicable tax rate and calculate the tax amount. This field is available when the field 'taxable' is set to true.  | [optional] 
+**tax_mode** | **String** | Determines whether the tax amount is inclusive or exclusive for the transaction line item. This field is available when the field 'taxable' is set to true.  | [optional] 
 **currency** | **String** |  | 
 **periods** | [**[UpsertCreateCommitmentInputAllOfPeriods]**](UpsertCreateCommitmentInputAllOfPeriods.md) | The new periods are required when creating a new Commitment. | [optional] 
 **period_alignment_option** | [**PeriodAlignmentOptionEnum**](PeriodAlignmentOptionEnum.md) |  | [optional] 

package/docs/UpsertUpdateCommitmentInput.md

@@ -4,6 +4,24 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**adjustment_liability_accounting_code** | **String** | The accounting code on the Commitment object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**adjustment_revenue_accounting_code** | **String** | The accounting code on the Commitment object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**contract_asset_accounting_code** | **String** | The accounting code on the Commitment object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**contract_liability_accounting_code** | **String** | The accounting code on the Commitment object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**contract_recognized_revenue_accounting_code** | **String** | The accounting code on the Commitment object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**deferred_revenue_accounting_code** | **String** | The deferred revenue accounting code for the Commitment.  | [optional] 
+**exclude_item_billing_from_revenue_accounting** | **Boolean** | The flag to exclude Commitment related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.   **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.   | [optional] 
+**is_allocation_eligible** | **Boolean** | This field is used to identify if the commitment is allocation eligible in revenue recognition.  **Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.  | [optional] 
+**is_unbilled** | **Boolean** | This field is used to dictate how to perform the accounting during revenue recognition.  **Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.  | [optional] 
+**recognized_revenue_accounting_code** | **String** | The recognized revenue accounting code for the Commitment.  | [optional] 
+**revenue_recognition_rule** | **String** | The Revenue Recognition rule for the Commitment.  | [optional] 
+**account_receivable_accounting_code** | **String** | The accounting code on the Commitment object for customers | [optional] 
+**unbilled_receivables_accounting_code** | **String** | The accounting code on the Commitment object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  | [optional] 
+**revenue_recognition_timing** | **String** | This field is used to dictate the type of revenue recognition timing. | [optional] 
+**revenue_amortization_method** | **String** | This field is used to dictate the type of revenue amortization method. | [optional] 
+**taxable** | **Boolean** | Determines whether a transaction line item in the billing document is taxable. If this field is set to true, both the fields taxCode and taxMode are required.  | [optional] 
+**tax_code** | **String** | The identifier or set of characters assigned to a transaction line item to determine the applicable tax rate and calculate the tax amount. This field is available when the field 'taxable' is set to true.  | [optional] 
+**tax_mode** | **String** | Determines whether the tax amount is inclusive or exclusive for the transaction line item. This field is available when the field 'taxable' is set to true.  | [optional] 
 **action** | [**ActionType**](ActionType.md) |  | 
 **commitment_number** | **String** | The number of the Commitment. | 
 **name** | **String** | The value to update. Set to null to clear the existing value. | [optional] 
@@ -14,3 +32,14 @@ Name | Type | Description | Notes
 **schedules** | [**[UpsertCommitmentScheduleInput]**](UpsertCommitmentScheduleInput.md) |  | [optional] 
 
 
+
+## Enum: TaxModeEnum
+
+
+* `TaxInclusive` (value: `"TaxInclusive"`)
+
+* `TaxExclusive` (value: `"TaxExclusive"`)
+
+
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zuora-sdk-js",
-  "version": "3.14.0",
+  "version": "3.15.0",
   "author": {
     "name": "Zuora",
     "email": "",

package/src/ZuoraClient.js

@@ -8,12 +8,14 @@ import {
     AggregateQueriesApi,
     APIHealthApi,
     AttachmentsApi,
+    BalanceTrackingApi,
     BillingDocumentsApi,
     BillingPreviewRunApi,
     BillRunApi,
     BillRunHealthApi,
     BookingDateBackfillJobApi,
     CatalogGroupsApi,
+    CommitmentsApi,
     ContactsApi,
     ContactSnapshotsApi,
     CreditMemosApi,
@@ -292,6 +294,10 @@ class ZuoraClient {
         return new AttachmentsApi(this.apiClient);
     }
 
+    get balanceTrackingApi() {
+        return new BalanceTrackingApi(this.apiClient);
+    }
+
     get billingDocumentsApi() {
         return new BillingDocumentsApi(this.apiClient);
     }
@@ -316,6 +322,10 @@ class ZuoraClient {
         return new CatalogGroupsApi(this.apiClient);
     }
 
+    get commitmentsApi() {
+        return new CommitmentsApi(this.apiClient);
+    }
+
     get contactsApi() {
         return new ContactsApi(this.apiClient);
     }

package/src/zuora_api/ApiClient.js

@@ -17,7 +17,7 @@ import querystring from "querystring";
 
 /**
 * @module ApiClient
-* @version 3.14.0
+* @version 3.15.0
 */
 
 /**
@@ -55,7 +55,7 @@ class ApiClient {
          * @default {}
          */
         this.defaultHeaders = {
-            'User-Agent': 'zuora-js-sdk/3.14.0',
+            'User-Agent': 'zuora-js-sdk/3.15.0',
             'Zuora-Version': '2025-08-12'
         };
 

package/src/zuora_api/api/APIHealthApi.js

@@ -21,7 +21,7 @@ import SystemHealthErrorResponse from '../model/SystemHealthErrorResponse';
 /**
 * APIHealth service.
 * @module api/APIHealthApi
-* @version 3.14.0
+* @version 3.15.0
 */
 export default class APIHealthApi {
 

package/src/zuora_api/api/AccountingCodesApi.js

@@ -25,7 +25,7 @@ import UpdateAccountingCodeRequest from '../model/UpdateAccountingCodeRequest';
 /**
 * AccountingCodes service.
 * @module api/AccountingCodesApi
-* @version 3.14.0
+* @version 3.15.0
 */
 export default class AccountingCodesApi {