zuora-sdk-js 3.3.0 → 3.4.0

package/docs/UpdateOrderLineItemRequest.md

@@ -0,0 +1,53 @@
+# ZuoraSdkJs.UpdateOrderLineItemRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**UOM** | **String** | Specifies the units to measure usage.  You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**accounting_code** | **String** | The accountingCode for the Order Line Item (OLI).  You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**adjustment_liability_accounting_code** | **String** | The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**adjustment_revenue_accounting_code** | **String** | The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**amount_per_unit** | **Number** | The actual charged amount per unit for the Order Line Item (OLI).  You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**bill_target_date** | **String** | The target date for the Order Line Item (OLI) to be picked up by bill run for generating billing documents.  To generate billing documents for an OLI, you must set this field and set the `itemState` field to `SentToBilling`.  You can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**bill_to** | **String** | The ID of a contact that belongs to the billing account of the order line item. Use this field to assign an existing account as the bill-to contact of an order line item.  You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**billing_rule** | [**OrderLineItemBillingRule**](OrderLineItemBillingRule.md) |  | [optional] 
+**contract_asset_accounting_code** | **String** | The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**contract_liability_accounting_code** | **String** | The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**contract_recognized_revenue_accounting_code** | **String** | The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**custom_fields** | **{String: Object}** | Container for custom fields of an Order Line Item object.  | [optional] 
+**deferred_revenue_accounting_code** | **String** | The deferred revenue accounting code for the Order Line Item (OLI).  You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**description** | **String** | The description of the Order Line Item (OLI).  You can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**inline_discount_per_unit** | **Number** | You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  Use this field in accordance with the `inlineDiscountType` field, in the following manner: * If the `inlineDiscountType` field is set as `Percentage`, this field specifies the discount percentage for each unit of the order line item. For exmaple, if you specify `5` in this field, the discount percentage is 5%. * If the `inlineDiscountType` field is set as `FixedAmount`, this field specifies the discount amount on each unit of the order line item. For exmaple, if you specify `10` in this field, the discount amount on each unit of the order line item is 10.  Once you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.  | [optional] 
+**inline_discount_type** | [**OrderLineItemInlineDiscountType**](OrderLineItemInlineDiscountType.md) |  | [optional] 
+**invoice_group_number** | **String** | The invoice group number associated with the order line item.  You can update this field only for a sales OLI and only when the sales OLI is in the `Executing`/`Booked`/`SentToBilling` state (when the `itemState` field is set as `Executing`/`Booked`/`SentToBilling`).  | [optional] 
+**is_allocation_eligible** | **Boolean** | This field is used to identify if the charge segment is allocation eligible in revenue recognition.  **Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.  | [optional] 
+**is_unbilled** | **Boolean** | This field is used to dictate how to perform the accounting during revenue recognition.  **Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.  | [optional] 
+**exclude_item_billing_from_revenue_accounting** | **Boolean** | The flag to exclude Order Line Item related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.   **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.   | [optional] 
+**exclude_item_booking_from_revenue_accounting** | **Boolean** | The flag to exclude Order Line Item from revenue accounting.  **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.  | [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] 
+**item_name** | **String** | The name of the Order Line Item (OLI).  You can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**item_number** | **String** | The number for the Order Line Item (OLI).  You can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**item_state** | [**OrderLineItemState**](OrderLineItemState.md) |  | [optional] 
+**item_type** | [**OrderLineItemType**](OrderLineItemType.md) |  | [optional] 
+**list_price_per_unit** | **Number** | The list price per unit for the Order Line Item (OLI).  You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**owner_account_number** | **String** | Use this field to assign an existing account as the owner of an order line item.  You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**product_code** | **String** | The product code for the Order Line Item (OLI).  You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**purchase_order_number** | **String** | Used by customers to specify the Purchase Order Number provided by the buyer.  You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**quantity** | **Number** | The quantity of units, such as the number of authors in a hosted wiki service.  You can update this field for a sales or return OLI only when the OLI in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**recognized_revenue_accounting_code** | **String** | The recognized revenue accounting code for the Order Line Item (OLI).  You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**related_subscription_number** | **String** | Use this field to relate an order line item to an subscription. Specify this field to the subscription number of the subscription to relate.  You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**revenue_recognition_rule** | **String** | The Revenue Recognition rule for the Order Line Item (OLI).  You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**sequence_set_id** | **String** | The ID of the sequence set associated with the orderLineItem. You can update this field only for a sales OLI and only when the sales OLI is in the `Executing`/`Booked`/`SentToBilling` state (when the `itemState` field is set as `Executing`/`Booked`/`SentToBilling`).  | [optional] 
+**payment_term** | **String** | The payment term name associated with the orderLineItem. You can update this field only for a sales OLI and only when the sales OLI is in the `Executing`/`Booked`/`SentToBilling` state (when the `itemState` field is set as `Executing`/`Booked`/`SentToBilling`).  | [optional] 
+**invoice_template_id** | **String** | The ID of the invoice template associated with the orderLineItem. You can update this field only for a sales OLI and only when the sales OLI is in the `Executing`/`Booked`/`SentToBilling` state (when the `itemState` field is set as `Executing`/`Booked`/`SentToBilling`).  | [optional] 
+**sold_to** | **String** | Use this field to assign an existing account as the sold-to contact of an order line item, by the following rules:  * If the `ownerAccountNumber` field is set, then this field must be the ID of a contact that belongs to the owner account of the order line item.  * If the `ownerAccountNumber` field is not set, then this field must be the ID of a contact that belongs to the billing account of the order line item.  You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**ship_to** | **String** | Use this field to assign an existing account as the ship-to contact of an order line item, by the following rules:  * If the `ownerAccountNumber` field is set, then this field must be the ID of a contact that belongs to the owner account of the order line item.  * If the `ownerAccountNumber` field is not set, then this field must be the ID of a contact that belongs to the billing account of the order line item.  You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**tax_code** | **String** | The tax code for the Order Line Item (OLI).  You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**tax_mode** | [**TaxMode**](TaxMode.md) |  | [optional] 
+**transaction_end_date** | **String** | The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the `transactionStartDate` field.  You can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**transaction_start_date** | **String** | The date a transaction starts. The default value of this field is the order date.  You can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+**unbilled_receivables_accounting_code** | **String** | The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).  You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).  | [optional] 
+
+

package/docs/UpdateOrderRequest.md

@@ -0,0 +1,22 @@
+# ZuoraSdkJs.UpdateOrderRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**category** | [**OrderCategory**](OrderCategory.md) |  | [optional] 
+**custom_fields** | **{String: Object}** | Container for custom fields of an Order object.  | [optional] 
+**description** | **String** | A description of the order. | [optional] 
+**existing_account_number** | **String** | The account number that this order will be created under. It can be either the accountNumber or the account info provided. It will return an error if both are specified. Note that this actually specifies the invoice owner account of the subscriptions included in this order.  | [optional] 
+**externally_managed_by** | [**ExternallyManagedBy**](ExternallyManagedBy.md) |  | [optional] 
+**new_account** | [**OrderCreateAccount**](OrderCreateAccount.md) |  | [optional] 
+**order_date** | **String** | The date when the order is signed. All the order actions under this order will use this order date as the contract effective date if the contract effective date field is skipped or its value is left as null. | 
+**order_line_items** | [**[CreateOrderOrderLineItem]**](CreateOrderOrderLineItem.md) | [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) are non subscription based items created by an Order, representing transactional charges such as one-time fees, physical goods, or professional service charges that are not sold as subscription services.   With the Order Line Items feature enabled, you can now launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models.  **Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default.          | [optional] 
+**order_number** | **String** | The order number of the new order. If not provided, system will auto-generate a number for this order.    **Note:** Make sure the order number does not contain a slash.   | [optional] 
+**processing_options** | [**ProcessingOptions**](ProcessingOptions.md) |  | [optional] 
+**reason_code** | **String** | Values of reason code configured in **Billing Settings** > **Configure Reason Codes** through Zuora UI. Indicates the reason when a return order line item occurs.  | [optional] 
+**scheduling_options** | [**OrderSchedulingOptions**](OrderSchedulingOptions.md) |  | [optional] 
+**status** | [**OrderStatus**](OrderStatus.md) |  | [optional] 
+**subscriptions** | [**[CreateOrderSubscription]**](CreateOrderSubscription.md) | Each item includes a set of order actions, which will be applied to the same base subscription. | [optional] 
+
+

package/docs/UpdateOrderSubscriptionsCustomFields.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.UpdateOrderSubscriptionsCustomFields
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**order_actions** | [**[UpdateOrderSubscriptionsOrderActionsCustomFields]**](UpdateOrderSubscriptionsOrderActionsCustomFields.md) |  | [optional] 
+**subscription_number** | **String** |  | [optional] 
+
+

package/docs/UpdateOrderSubscriptionsOrderActionsCustomFields.md

@@ -0,0 +1,11 @@
+# ZuoraSdkJs.UpdateOrderSubscriptionsOrderActionsCustomFields
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**custom_fields** | **{String: Object}** | Container for custom fields of an Order Action object.  | [optional] 
+**order_action_id** | **String** | The Id of the order action in the order. You can provide either the `sequence` or the `orderActionId` field to specify which order action to update. You cannot use then both at the same time.  | [optional] 
+**sequence** | **Number** | The sequence number of the order action in the order. You can provide either the `sequence` or the `orderActionId` field to specify which order action to update. You cannot use then both at the same time.  | [optional] 
+
+

package/docs/UpdateOrderTriggerDateResponse.md

@@ -0,0 +1,10 @@
+# ZuoraSdkJs.UpdateOrderTriggerDateResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**UpdateOrderTriggerDatesSubscriptionsStatus**](UpdateOrderTriggerDatesSubscriptionsStatus.md) |  | [optional] 
+**subscription_number** | **String** | Subscription number of the subscription updated. | [optional] 
+
+

package/docs/UpdateOrderTriggerDatesRequest.md

@@ -0,0 +1,9 @@
+# ZuoraSdkJs.UpdateOrderTriggerDatesRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subscriptions** | [**[UpdateOrderActionTriggerDatesRequest]**](UpdateOrderActionTriggerDatesRequest.md) |  | [optional] 
+
+

package/docs/UpdateOrderTriggerDatesResponse.md

@@ -0,0 +1,27 @@
+# ZuoraSdkJs.UpdateOrderTriggerDatesResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
+**request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
+**reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] 
+**account_number** | **String** | The account number for the order. | [optional] 
+**order_number** | **String** | The order number of the order updated. | [optional] 
+**status** | **String** | Status of the order. | [optional] 
+**subscriptions** | [**[UpdateOrderTriggerDateResponse]**](UpdateOrderTriggerDateResponse.md) | The subscriptions updated. | [optional] 
+
+
+
+## Enum: StatusEnum
+
+
+* `Completed` (value: `"Completed"`)
+
+* `Pending` (value: `"Pending"`)
+
+
+
+

package/docs/UpdateOrderTriggerDatesSubscriptionsStatus.md

@@ -0,0 +1,12 @@
+# ZuoraSdkJs.UpdateOrderTriggerDatesSubscriptionsStatus
+
+## Enum
+
+
+* `Active` (value: `"Active"`)
+
+* `Pending Activation` (value: `"Pending Activation"`)
+
+* `Pending Acceptance` (value: `"Pending Acceptance"`)
+
+

package/docs/UpdatePaymentMethodRequest.md

@@ -0,0 +1,19 @@
+# ZuoraSdkJs.UpdatePaymentMethodRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expiration_month** | **Number** | One or two digits expiration month (1-12).           | [optional] 
+**expiration_year** | **Number** | Four-digit expiration year.  | [optional] 
+**security_code** | **String** | Optional. It is the CVV or CVV2 security code specific for the credit card or debit card. To ensure PCI compliance, this value is not stored and cannot be queried.   If securityCode code is not passed in the request payload, this operation only updates related fields in the payload. It does not validate the payment method through the gateway.  If securityCode is passed in the request payload, this operation retrieves the credit card information from payload and validates them through the gateway.  | [optional] 
+**account_holder_info** | [**UpdaterPaymentMethodRequestAccountHolderInfo**](UpdaterPaymentMethodRequestAccountHolderInfo.md) |  | [optional] 
+**account_key** | **String** | The ID of the customer account associated with this payment method, such as `2x92c0f859b0480f0159d3a4a6ee5bb6`.  **Note:** You can use this field to associate an orphan payment method with a customer account. If a payment method is already associated with a customer account, you cannot change the associated payment method through this operation. You cannot remove the previous account ID and leave this field empty, either.  | [optional] 
+**auth_gateway** | **String** | Specifies the ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method.   This field is not supported in updating Credit Card Reference Transaction payment methods.  | [optional] 
+**currency_code** | **String** | The currency used for payment method authorization.  | [optional] 
+**gateway_options** | [**GatewayOptions**](GatewayOptions.md) |  | [optional] 
+**ip_address** | **String** | The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways.   If the IP address length is beyond 45 characters, a validation error occurs.  For validating SEPA payment methods on Stripe v2, this field is required.  | [optional] 
+**mandate_info** | [**PaymentMethodRequestMandateInfo**](PaymentMethodRequestMandateInfo.md) |  | [optional] 
+**processing_options** | [**PaymentMethodRequestProcessingOptions**](PaymentMethodRequestProcessingOptions.md) |  | [optional] 
+
+

package/docs/UpdatePaymentMethodRequestCreditCardInfo.md

@@ -0,0 +1,11 @@
+# ZuoraSdkJs.UpdatePaymentMethodRequestCreditCardInfo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expiration_month** | **Number** | One or two digits expiration month (1-12).           | [optional] 
+**expiration_year** | **Number** | Four-digit expiration year.  | [optional] 
+**security_code** | **String** | Optional. It is the CVV or CVV2 security code specific for the credit card or debit card. To ensure PCI compliance, this value is not stored and cannot be queried.   If securityCode code is not passed in the request payload, this operation only updates related fields in the payload. It does not validate the payment method through the gateway.  If securityCode is passed in the request payload, this operation retrieves the credit card information from payload and validates them through the gateway.  | [optional] 
+
+

package/docs/UpdatePaymentMethodResponse.md

@@ -0,0 +1,13 @@
+# ZuoraSdkJs.UpdatePaymentMethodResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
+**request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
+**reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] 
+**id** | **String** | Internal ID of the payment method that was created. | [optional] 
+
+

package/docs/UpdatePaymentRequest.md

@@ -0,0 +1,31 @@
+# ZuoraSdkJs.UpdatePaymentRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**comment** | **String** | Comments about the payment.  | [optional] 
+**finance_information** | [**PaymentRequestFinanceInformation**](PaymentRequestFinanceInformation.md) |  | [optional] 
+**gateway_state** | **String** | This field is mainly used for gateway reconciliation. See <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/DA_Electronic_Payment_Processing#Gateway_Reconciliation_Consideration\" target=\"_blank\">Electronic payment processing</a> for details.  You must have the **Edit Payment Gateway Status** <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Tenant_Management/A_Administrator_Settings/User_Roles/e_Payments_Roles\" target=\"_blank\">user permission</a> to update this field.  | [optional] 
+**payment_schedule_key** | **String** | The unique ID or the number of the payment schedule to be linked with the payment. See [Link payments to payment schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/Link_payments_with_payment_schedules) for more information. | [optional] 
+**reference_id** | **String** | The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.  You can only update the reference ID for external payments.  | [optional] 
+**gateway_reconciliation_status** | **String** |  | [optional] 
+**gateway_reconciliation_reason** | **String** |  | [optional] 
+**payout_id** | **String** |  | [optional] 
+
+
+
+## Enum: GatewayStateEnum
+
+
+* `NotSubmitted` (value: `"NotSubmitted"`)
+
+* `Submitted` (value: `"Submitted"`)
+
+* `Settled` (value: `"Settled"`)
+
+* `FailedToSettle` (value: `"FailedToSettle"`)
+
+
+
+

package/docs/UpdatePaymentRunRequest.md

@@ -0,0 +1,22 @@
+# ZuoraSdkJs.UpdatePaymentRunRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | The ID of the customer account associated with the payment run.  This field conflicts with each of the `batch`, `billCycleDay`, `currency`, `paymentGatewayId`, and `billingRunId` fields. If there are such conflicts, an error occurs and an error message is returned.  | [optional] 
+**apply_credit_balance** | **Boolean** | **Note:** This field is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled.  Whether to apply credit balances in the payment run. This field is only available when you have Invoice Settlement feature disabled.  | [optional] 
+**auto_apply_credit_memo** | **Boolean** | **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.  Whether to automatically apply a posted credit memo to one or more receivables in the payment run.  | [optional] 
+**auto_apply_unapplied_payment** | **Boolean** | **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.  Whether to automatically apply unapplied payments to  one or more receivables in the payment run.  | [optional] 
+**batch** | **String** | The alias name given to a batch. The batch name is a string of 50 characters or less.  This field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.   | [optional] 
+**bill_cycle_day** | **String** | The billing cycle day (BCD), the day of the month when a bill run generates invoices for the account. The value must be equal to or less then 31, and 31 is mean the EOM.  This field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.  | [optional] 
+**billing_run_id** | **String** | The ID of a bill run.  This field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.  | [optional] 
+**collect_payment** | **Boolean** | Whether to process electronic payments during the execution of payment runs.   If the Payment user permission \"Process Electronic Payment\" is disabled, this field will be ignored.  | [optional] 
+**consolidated_payment** | **Boolean** | **Note:** The **Process Electronic Payment** permission also needs to be allowed for a Manage Payment Runs role to work. See [Payments Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles) for more information.   Whether to process a single payment for all receivables that are due on an account.  | [optional] 
+**currency** | **String** | A currency defined in the web-based UI administrative settings.  This field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.  | [optional] 
+**payment_gateway_id** | **String** | The ID of the gateway instance that processes the payment.  This field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.  | [optional] 
+**process_payment_with_closed_pm** | **Boolean** | **Note:** The **Process Electronic Payment** permission also needs to be allowed for a Manage Payment Runs role to work. See [Payments Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles) for more information.   Whether to process payments even if the default payment method is closed.  | [optional] 
+**run_date** | **Date** | The date and time when the scheduled payment run is to be executed, in `yyyy-mm-dd hh:mm:ss` format. The backend will ignore mintues and seconds in the field value. For example, if you specify `2017-03-01 11:30:37` for this value, this payment run will be run at 2017-03-01 11:00:00.  | [optional] 
+**target_date** | **String** | The target date used to determine which receivables to be paid in the payment run. The payments are collected for all receivables with the due date no later than the target date.  | [optional] 
+
+

package/docs/UpdatePaymentScheduleItemRequest.md

@@ -0,0 +1,19 @@
+# ZuoraSdkJs.UpdatePaymentScheduleItemRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Number** | The amount of the payment.  | [optional] 
+**currency** | **String** | The currency of the payment.  | [optional] 
+**description** | **String** | The description of the payment schedule item.  | [optional] 
+**link_payments** | [**[PaymentScheduleLinkedPaymentID]**](PaymentScheduleLinkedPaymentID.md) | Container for payments linked to the payment schedule item.  | [optional] 
+**payment_gateway_id** | **String** | ID of the payment gateway of the payment schedule item.  | [optional] 
+**payment_id** | **String** | ID of the payment to be linked to the payment schedule item.  **Note**: This feild is version controlled. To enable this field, you must set `zuora-version` to equal or smaller than `336.0`.  | [optional] 
+**payment_method_id** | **String** | ID of the payment method of the payment schedule item.  | [optional] 
+**payment_option** | [**[PaymentSchedulePaymentOptionFields]**](PaymentSchedulePaymentOptionFields.md) | Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.  Here is an example: ``` \"paymentOption\": [   {     \"type\": \"GatewayOptions\",     \"detail\": {       \"SecCode\":\"WEB\"     }   } ] ```  `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.  To enable this field, submit a request at [Zuora Global Support](https://support.zuora.com/). This field is only available if `zuora-version` is set to `337.0` or later.  | [optional] 
+**run_hour** | **Number** | At which hour of the day in the tenant’s timezone this payment will be collected. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.  | [optional] 
+**scheduled_date** | **String** | The scheduled date when the payment is processed.  | [optional] 
+**unlink_payments** | [**[PaymentScheduleLinkedPaymentID]**](PaymentScheduleLinkedPaymentID.md) | Container for payments to be unlinked from the payment schedule item.  | [optional] 
+
+

package/docs/UpdatePaymentScheduleRequest.md

@@ -0,0 +1,30 @@
+# ZuoraSdkJs.UpdatePaymentScheduleRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Number** | Indicates the updated amount of the pending payment schedule items.  | [optional] 
+**currency** | **String** | Indicates the updated currency of the pending payment schedule items.  | [optional] 
+**occurrences** | **Number** | Indicates the updated number of payment schedule items that are created by the payment schedule.  **Note:**   - If \"updated `occurrences` > existing `occurrences`\", the following number of pending payment schedule item will be added to the payment schedule: “updated `occurrences` - existing `occurrences`”.   - If \"existing `occurrences` > updated `occurrences` >= the number of `processed`/`errored`/`canceled` payment schedule items\", the following number of pending items will be removed by descending order of the schedule dates: \"existing `occurrences` - updated `occurrences`\".   - If \"updated `occurrences` < the number of `processed`/`erroed`/`canceled` payment schedule items\", a validation error will be returned.  | [optional] 
+**payment_gateway_id** | **String** | Indicates the updated payment gateway ID of the pending payment schedule items.  | [optional] 
+**payment_method_id** | **String** | Indicates the updated payment method ID of the pending payment schedule items.  | [optional] 
+**payment_option** | [**[PaymentSchedulePaymentOptionFields]**](PaymentSchedulePaymentOptionFields.md) | Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.  Here is an example: ``` \"paymentOption\": [   {     \"type\": \"GatewayOptions\",     \"detail\": {       \"SecCode\":\"WEB\"     }   } ] ```  `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.  To enable this field, submit a request at [Zuora Global Support](https://support.zuora.com/). This field is only available if `zuora-version` is set to `337.0` or later.  | [optional] 
+**period** | **String** | Indicates the updated period of the pending payment schedule items.  | [optional] 
+**period_start_date** | **String** | Indicates the updated collection date for the next pending payment schedule item.  | [optional] 
+**run_hour** | **Number** | Specifies at which hour of the day in the tenant’s time zone this payment will be collected. Available values: `[0,1,2,~,22,23]`.    If the time difference between your tenant’s timezone and the timezone where Zuora servers are is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half hour later than your scheduled time. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.  | [optional] 
+
+
+
+## Enum: PeriodEnum
+
+
+* `Monthly` (value: `"Monthly"`)
+
+* `Weekly` (value: `"Weekly"`)
+
+* `BiWeekly` (value: `"BiWeekly"`)
+
+
+
+

package/docs/UpdateProductRatePlanChargeRequest.md

@@ -0,0 +1,88 @@
+# ZuoraSdkJs.UpdateProductRatePlanChargeRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**class__ns** | **String** | Class associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**deferred_rev_account__ns** | **String** | Deferrred revenue account associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**department__ns** | **String** | Department associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**include_children__ns** | [**ProductRatePlanChargeObjectNSFieldsIncludeChildrenNS**](ProductRatePlanChargeObjectNSFieldsIncludeChildrenNS.md) |  | [optional] 
+**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**integration_status__ns** | **String** | Status of the product rate plan charge's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**item_type__ns** | [**ProductRatePlanChargeObjectNSFieldsItemTypeNS**](ProductRatePlanChargeObjectNSFieldsItemTypeNS.md) |  | [optional] 
+**location__ns** | **String** | Location associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**recognized_rev_account__ns** | **String** | Recognized revenue account associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**rev_rec_end__ns** | [**ProductRatePlanChargeObjectNSFieldsRevRecEndNS**](ProductRatePlanChargeObjectNSFieldsRevRecEndNS.md) |  | [optional] 
+**rev_rec_start__ns** | [**ProductRatePlanChargeObjectNSFieldsRevRecStartNS**](ProductRatePlanChargeObjectNSFieldsRevRecStartNS.md) |  | [optional] 
+**rev_rec_template_type__ns** | **String** | Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**subsidiary__ns** | **String** | Subsidiary associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**sync_date__ns** | **String** | Date when the product rate plan charge was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**product_rate_plan_id** | **String** | The ID of the product rate plan associated with this product rate plan charge.  | 
+**accounting_code** | **String** | The accounting code for the charge. Accounting codes group transactions that contain similar accounting attributes.  | [optional] 
+**apply_discount_to** | [**ApplyDiscountTo**](ApplyDiscountTo.md) |  | [optional] 
+**bill_cycle_day** | **Number** | Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month customer is billed. The BCD value in the account can override the BCD in this object.  **Character limit**: 2  **Values**: a valid BCD integer, 1 - 31  | [optional] 
+**bill_cycle_type** | [**BillCycleType**](BillCycleType.md) |  | 
+**billing_period** | [**BillingPeriodProductRatePlanChargeRest**](BillingPeriodProductRatePlanChargeRest.md) |  | 
+**billing_period_alignment** | [**BillingPeriodAlignmentProductRatePlanChargeRest**](BillingPeriodAlignmentProductRatePlanChargeRest.md) |  | [optional] 
+**billing_timing** | [**BillingTimingProductRatePlanChargeRest**](BillingTimingProductRatePlanChargeRest.md) |  | [optional] 
+**charge_function** | [**ChargeFunction**](ChargeFunction.md) |  | [optional] 
+**charge_model** | [**ChargeModelProductRatePlanChargeRest**](ChargeModelProductRatePlanChargeRest.md) |  | 
+**charge_model_configuration** | [**ChargeModelConfiguration**](ChargeModelConfiguration.md) |  | [optional] 
+**commitment_type** | [**CommitmentType**](CommitmentType.md) |  | [optional] 
+**credit_option** | [**PrepaidDrawdownCreditOption**](PrepaidDrawdownCreditOption.md) |  | [optional] 
+**default_quantity** | **Number** | The default quantity of units, such as the number of authors in a hosted wiki service. This field is required if you use a per-unit pricing model.   **Character limit**: 16  **Values**: a valid quantity value.   **Note:** When the `ChargeModel` field is set to `Tiered Pricing` or `Volume Pricing`, if this field is not specified, the value will default to `0`.  | [optional] 
+**deferred_revenue_account** | **String** | The name of the deferred revenue account for this charge.  This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).   | [optional] 
+**delivery_schedule** | [**DeliveryScheduleProductRatePlanCharge**](DeliveryScheduleProductRatePlanCharge.md) |  | [optional] 
+**description** | **String** | A description of the charge.  | [optional] 
+**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] 
+**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]
+**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] 
+**included_units** | **Number** | Specifies the number of units in the base set of units.  **Character limit**: 16  **Values**: a positive decimal value  | [optional] 
+**is_prepaid** | **Boolean** | **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.   Indicates whether this charge is a prepayment (topup) charge or a drawdown charge. Values: `true` or `false`.  | [optional] 
+**is_rollover** | **Boolean** | **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 value is either \"True\" or \"False\". It determines whether the rollover fields are needed.  | [optional] 
+**is_stacked_discount** | **Boolean** | **Note**: This field is only applicable to the Discount - Percentage charge model.  To use this field, you must set the `X-Zuora-WSDL-Version` request header to 130 or higher. Otherwise, an error occurs.  This field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows:   - `True`: This is a stacked discount, which should be calculated by stacking with other discounts.   - `False`: This is not a stacked discount, which should be calculated in sequence with other discounts.  For more information, see [Stacked discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models).  | [optional] 
+**legacy_revenue_reporting** | **Boolean** |  | [optional] 
+**list_price_base** | [**ListPriceBase**](ListPriceBase.md) |  | [optional] 
+**min_quantity** | **Number** | Specifies the minimum number of units for this charge. Use this field and the `MaxQuantity` field to create a range of units allowed in a product rate plan charge.  **Character limit**: 16  **Values**: a positive decimal value  | [optional] 
+**max_quantity** | **Number** | Specifies the maximum number of units for this charge. Use this field and the `MinQuantity` field to create a range of units allowed in a product rate plan charge.  **Character limit**: 16  **Values**: a positive decimal value  | [optional] 
+**name** | **String** | The name of the product rate plan charge.  | [optional] 
+**number_of_period** | **Number** | Specifies the number of periods to use when calculating charges in an overage smoothing charge model. The valid value must be a positive whole number.  | [optional] 
+**overage_calculation_option** | [**OverageCalculationOption**](OverageCalculationOption.md) |  | [optional] 
+**overage_unused_units_credit_option** | [**OverageUnusedUnitsCreditOption**](OverageUnusedUnitsCreditOption.md) |  | [optional] 
+**prepaid_quantity** | **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 number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number.  | [optional] 
+**prepaid_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 [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).  | [optional] 
+**price_change_option** | [**PriceChangeOption**](PriceChangeOption.md) |  | [optional] 
+**price_increase_option** | [**PriceIncreaseOption**](PriceIncreaseOption.md) |  | [optional] 
+**price_increase_percentage** | **Number** | Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the value to `SpecificPercentageValue`.  **Character limit**: 16  **Values**: a decimal value between -100 and 100  | [optional] 
+**product_rate_plan_charge_number** | **String** | The natural key of the product rate plan charge.   For existing Product Rate Plan Charge objects that are created before this field is introduced, this field will be null. Use this field to specify a value for only these objects. Zuora also provides a tool to help you automatically backfill this field with tenant ID for your existing product catalog. If you want to use this backfill tool, contact [Zuora Global Support](https://support.zuora.com/).  **Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later.  | [optional] 
+**product_rate_plan_charge_tier_data** | [**ProductRatePlanChargeTierData**](ProductRatePlanChargeTierData.md) |  | 
+**rating_group** | [**RatingGroup**](RatingGroup.md) |  | [optional] 
+**recognized_revenue_account** | **String** | The name of the recognized revenue account for this charge.   - Required when the Allow Blank Accounting Code setting is No.   - Optional when the Allow Blank Accounting Code setting is Yes.    This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).   | [optional] 
+**rev_rec_code** | **String** | Associates this product rate plan charge with a specific revenue recognition code.  | [optional] 
+**rev_rec_trigger_condition** | [**RevRecTriggerConditionProductRatePlanChargeRest**](RevRecTriggerConditionProductRatePlanChargeRest.md) |  | [optional] 
+**revenue_recognition_rule_name** | [**RevenueRecognitionRuleName**](RevenueRecognitionRuleName.md) |  | [optional] 
+**rollover_apply** | [**RolloverApply**](RolloverApply.md) |  | [optional] 
+**rollover_periods** | **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.  This field defines the number of rollover periods, it is restricted to 3.  | [optional] 
+**smoothing_model** | [**SmoothingModel**](SmoothingModel.md) |  | [optional] 
+**specific_billing_period** | **Number** | Customizes the number of months or weeks for the charges billing period. This field is required if you set the value of the BillingPeriod field to `Specific Months` or `Specific Weeks`. The valid value is a positive integer.  | [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`.  **Notes**:    - 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.   - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `129` or later. Otherwise, an error occurs.   - The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`.  | [optional] 
+**tax_code** | **String** | Specifies the tax code for taxation rules. Required when the Taxable field is set to `True`.  **Note**: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`.  | [optional] 
+**tax_mode** | [**TaxMode**](TaxMode.md) |  | [optional] 
+**taxable** | **Boolean** | Determines whether the charge is taxable. When set to `True`, the TaxMode and TaxCode fields are required when creating or updating th ProductRatePlanCharge object.  **Character limit**: 5  **Values**: `True`, `False`  **Note**: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`.  | [optional] 
+**trigger_event** | [**TriggerEventProductRatePlanChargeRest**](TriggerEventProductRatePlanChargeRest.md) |  | 
+**UOM** | **String** | Specifies the units to measure usage.   **Note**: You must specify this field when creating the following charge models:   - Per Unit Pricing   - Volume Pricing   - Overage Pricing   - Tiered Pricing   - Tiered with Overage Pricing  | [optional] 
+**up_to_periods** | **Number** | Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends.  **Character limit**: 5  **Values**: a whole number between 0 and 65535, exclusive  **Notes**:   - You must use this field together with the `UpToPeriodsType` field to specify the time period. This field is applicable only when the `EndDateCondition` field is set to `FixedPeriod`.    - If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end.  | [optional] 
+**up_to_periods_type** | [**UpToPeriodsTypeProductRatePlanChargeRest**](UpToPeriodsTypeProductRatePlanChargeRest.md) |  | [optional] 
+**usage_record_rating_option** | [**UsageRecordRatingOption**](UsageRecordRatingOption.md) |  | [optional] 
+**use_discount_specific_accounting_code** | **Boolean** | Determines whether to define a new accounting code for the new discount charge.  **Character limit**: 5  **Values**: `True`, `False`  | 
+**use_tenant_default_for_price_change** | **Boolean** | Applies the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal.   **Character limit**: 5  **Values**: `true`, `false`  | [optional] 
+**validity_period_type** | [**ValidityPeriodType**](ValidityPeriodType.md) |  | [optional] 
+**weekly_bill_cycle_day** | [**WeeklyBillCycleDay**](WeeklyBillCycleDay.md) |  | [optional] 
+
+

package/docs/UpdateProductRatePlanChargeTierRequest.md

@@ -0,0 +1,9 @@
+# ZuoraSdkJs.UpdateProductRatePlanChargeTierRequest
+
+## Properties
+
+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] 
+
+

package/docs/UpdateProductRatePlanRequest.md

@@ -0,0 +1,28 @@
+# ZuoraSdkJs.UpdateProductRatePlanRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**billing_period__ns** | [**ProductRatePlanObjectNSFieldsBillingPeriodNS**](ProductRatePlanObjectNSFieldsBillingPeriodNS.md) |  | [optional] 
+**class__ns** | **String** | Class associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**department__ns** | **String** | Department associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**include_children__ns** | [**ProductRatePlanObjectNSFieldsIncludeChildrenNS**](ProductRatePlanObjectNSFieldsIncludeChildrenNS.md) |  | [optional] 
+**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**integration_status__ns** | **String** | Status of the product rate plan's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**item_type__ns** | [**ProductRatePlanObjectNSFieldsItemTypeNS**](ProductRatePlanObjectNSFieldsItemTypeNS.md) |  | [optional] 
+**location__ns** | **String** | Location associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**multi_currency_price__ns** | **String** | Multi-currency price associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**price__ns** | **String** | Price associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**subsidiary__ns** | **String** | Subsidiary associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**sync_date__ns** | **String** | Date when the product rate plan was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**product_rate_plan_number** | **String** | The natural key of the product rate plan.   For existing Product Rate Plan objects that are created before this field is introduced, this field will be null. Use this field to specify a value for only these objects. Zuora also provides a tool to help you automatically backfill this field with tenant ID for your existing product catalog. If you want to use this backfill tool, contact [Zuora Global Support](https://support.zuora.com/).  **Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later.  | [optional] 
+**name** | **String** | The name of the product rate plan. The name doesn't have to be unique in a Product Catalog, but the name has to be unique within a product.  | [optional] 
+**product_id** | **String** | The ID of the product that contains the product rate plan.  | [optional] 
+**active_currencies** | **[String]** | A list of 3-letter currency codes representing active currencies for the product rate plan. Use a comma to separate each currency code.  If the request body contains this field, the value of this field must contain the desired list of active currencies. The new list can never have more than four differences from the existing list.  This field cannot be used to modify the status of more than four currencies in a single request. For example, in a single request, you can only activate four currencies, or deactivate four currencies, or activate two and deactivate two. Making more than four changes to currencies always requires more than one call.  When specifying this field in the update request, you must provide the full list of active currencies you want, not just incremental changes. For each active currency update, provide the following currencies in the list:  Current active currencies + at most four changes (additions or deletions)  | [optional] 
+**description** | **String** | A description of the product rate plan.  | [optional] 
+**effective_start_date** | **String** | The date when the product rate plan becomes available and can be subscribed to, in `yyyy-mm-dd` format.  | [optional] 
+**effective_end_date** | **String** | The date when the product rate plan expires and can't be subscribed to, in `yyyy-mm-dd` format.  | [optional] 
+**grade** | **Number** | The grade that is assigned for the product rate plan. The value of this field must be a positive integer. The greater the value, the higher the grade.  A product rate plan to be added to a Grading catalog group must have one grade. You can specify a grade for a product rate plan in this request or update the product rate plan individually.  **Notes**:    - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `116` or later. Otherwise, an error occurs.   - This field is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/).  | [optional] 
+
+

package/docs/UpdateProductRequest.md

@@ -0,0 +1,20 @@
+# ZuoraSdkJs.UpdateProductRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**integration_status__ns** | **String** | Status of the product's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**item_type__ns** | [**ProductObjectNSFieldsItemTypeNS**](ProductObjectNSFieldsItemTypeNS.md) |  | [optional] 
+**sync_date__ns** | **String** | Date when the product was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**SKU** | **String** | The unique SKU for the product.  | [optional] 
+**name** | **String** | The name of the product. This information is displayed in the product catalog pages in the web-based UI.  | [optional] 
+**product_number** | **String** | The natural key of the product.   For existing Product objects that are created before this field is introduced, this field will be null. Use this field to specify a value for only these objects. Zuora also provides a tool to help you automatically backfill this field with tenant ID for your existing product catalog. If you want to use this backfill tool, contact [Zuora Global Support](https://support.zuora.com/).  **Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later.  | [optional] 
+**category** | [**ProductCategory**](ProductCategory.md) |  | [optional] 
+**description** | **String** | A description of the product.   | [optional] 
+**effective_start_date** | **String** | The date when the product becomes available and can be subscribed to, in `yyyy-mm-dd` format.  | [optional] 
+**effective_end_date** | **String** | The date when the product expires and can't be subscribed to anymore, in `yyyy-mm-dd` format.  | [optional] 
+**allow_feature_changes** | **Boolean** | Controls whether to allow your users to add or remove features while creating or amending a subscription.  **Values**: true, false (default)  | [optional] 
+
+

package/docs/UpdateRatePlanCharge.md

@@ -0,0 +1,21 @@
+# ZuoraSdkJs.UpdateRatePlanCharge
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**billing_period_alignment** | **String** | Aligns charges within the same subscription if multiple charges begin on different dates.  Values:  * `AlignToCharge` * `AlignToSubscriptionStart` * `AlignToTermStart`  Available for the following charge types:  * Recurring * Usage-based  | [optional] 
+**charge_model_configuration** | [**ChargeModelConfigurationForSubscription**](ChargeModelConfigurationForSubscription.md) |  | [optional] 
+**description** | **String** | Description of the charge.  | [optional] 
+**included_units** | **Number** | Specifies the number of units in the base set of units for this charge. Must be >=0.  Available for the following charge type for the Overage charge model: * Usage-based  | [optional] 
+**overage_price** | **Number** | Price for units over the allowed amount.   Available for the following charge type for the Overage and Tiered with Overage charge models:  * Usage-based  | [optional] 
+**price** | **Number** | Price for units in the subscription rate plan.  Supports all charge types for the Flat Fee and Per Unit charge models  | [optional] 
+**price_change_option** | **String** | Applies an automatic price change when a termed subscription is renewed. The Billing Admin setting **Enable Automatic Price Change When Subscriptions are Renewed?** must be set to Yes to use this field.  Values:  * `NoChange` (default) * `SpecificPercentageValue` * `UseLatestProductCatalogPricing`  Available for the following charge types:  * Recurring * Usage-based  Not available for the Fixed-Amount Discount charge model.  | [optional] 
+**price_increase_percentage** | **Number** | Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Required if you set the `PriceChangeOption` field to `SpecificPercentageValue`.  Decimal between `-100` and `100`.  Available for the following charge types:  * Recurring * Usage-based  Not available for the Fixed-Amount Discount charge model.  | [optional] 
+**quantity** | **Number** | Quantity of units; must be greater than zero.  | [optional] 
+**rate_plan_charge_id** | **String** | ID of a rate-plan charge for this subscription. It can be the latest version or any history version of ID.  | 
+**tiers** | [**[Tier]**](Tier.md) | Container for Volume, Tiered or Tiered with Overage charge models. Supports the following charge types:  * One-time * Recurring * Usage-based  | [optional] 
+**trigger_date** | **String** | Specifies when to start billing the customer for the charge. Required if the `triggerEvent` field is set to USD.  `triggerDate` cannot be updated for the following using the REST update subscription call:  * One-time charge type * Discount-Fixed Amount charge model * Discount-Percentage charge model  | [optional] 
+**trigger_event** | **String** | Specifies when to start billing the customer for the charge.  Values:  * `UCE` * `USA` * `UCA` * `USD`  This is the date when charge changes in the REST request become effective.  `triggerEvent` cannot be updated for the following using the REST update subscription call:  * One-time charge type * Discount-Fixed Amount charge model * Discount-Percentage charge model  | [optional] 
+
+

package/docs/UpdateRefundRequest.md

@@ -0,0 +1,15 @@
+# ZuoraSdkJs.UpdateRefundRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**comment** | **String** | Comments about the refund.  | [optional] 
+**finance_information** | [**RefundRequestFinanceInformation**](RefundRequestFinanceInformation.md) |  | [optional] 
+**reason_code** | **String** | A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.  | [optional] 
+**reference_id** | **String** | The transaction ID returned by the payment gateway. Use this field to reconcile refunds between your gateway and Zuora Payments.  You can only update the reference ID for external refunds.  | [optional] 
+**gateway_reconciliation_status** | **String** |  | [optional] 
+**gateway_reconciliation_reason** | **String** |  | [optional] 
+**payout_id** | **String** |  | [optional] 
+
+