zuora-sdk-js 3.6.0 → 3.7.0

package/docs/CreateSubscribeToProduct.md

@@ -6,13 +6,13 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **charge_overrides** | [**[ChargeOverride]**](ChargeOverride.md) | List of charges associated with the rate plan.  | [optional] 
 **clearing_existing_features** | **Boolean** | Specifies whether all features in the rate plan will be cleared.  | [optional] 
-**custom_fields** | **{String: Object}** | Container for custom fields of the Rate Plan object. The custom fields of the Rate Plan object are used when rate plans are subscribed.  | [optional] 
-**external_catalog_plan_id** | **String** | An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan.  **Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.  | [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] 
-**product_rate_plan_id** | **String** | Internal identifier of the product rate plan that the rate plan is based on.  | [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] 
+**external_catalog_plan_id** | **String** | An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan.   **Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. | [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] 
+**product_rate_plan_id** | **String** | Internal identifier of the product rate plan that the rate plan is based on. | [optional] 
 **product_rate_plan_number** | **String** | Number of a product rate plan for this subscription.  | [optional] 
-**subscription_product_features** | [**[CreateOrderRatePlanFeatureOverride]**](CreateOrderRatePlanFeatureOverride.md) | List of features associated with the rate plan. The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows: * If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared. * If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.  | [optional] 
-**unique_token** | **String** | Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.  For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.  | [optional] 
+**subscription_product_features** | [**[CreateOrderRatePlanFeatureOverride]**](CreateOrderRatePlanFeatureOverride.md) | List of features associated with the rate plan.  The system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:  * If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.  * If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan. | [optional] 
+**unique_token** | **String** | Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.   For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify. | [optional] 
 **subscription_rate_plan_number** | **String** | Number of a subscription rate plan for this subscription.  | [optional] 
 **is_from_external_catalog** | **Boolean** | Indicates whether the rate plan is created from the Zuora product catalog or from an external product catalog.  **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.  | [optional] 
 **rate_plan_name** | **String** | Name of the standalone rate plan.  **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.  | [optional] 

package/docs/CreateSubscriptionRequest.md

@@ -4,49 +4,49 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**cpq_bundle_json_id__qt** | **String** | The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field.  | [optional] 
-**opportunity_close_date__qt** | **String** | The closing date of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.  | [optional] 
-**opportunity_name__qt** | **String** | The unique identifier of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.  | [optional] 
-**quote_business_type__qt** | **String** | The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal or Churn. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.  | [optional] 
-**quote_number__qt** | **String** | The unique identifier of the Quote. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.  | [optional] 
-**quote_type__qt** | **String** | The Quote type that represents the subscription lifecycle stage such as New, Amendment, Renew or Cancel. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.  | [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 subscription's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**project__ns** | **String** | The NetSuite project that the subscription was created from. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**sales_order__ns** | **String** | The NetSuite sales order than the subscription was created from. 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 subscription was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**cpq_bundle_json_id__qt** | **String** | The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field. | [optional] 
+**opportunity_close_date__qt** | **String** | The closing date of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. | [optional] 
+**opportunity_name__qt** | **String** | The unique identifier of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. | [optional] 
+**quote_business_type__qt** | **String** | The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal or Churn. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. | [optional] 
+**quote_number__qt** | **String** | The unique identifier of the Quote. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. | [optional] 
+**quote_type__qt** | **String** | The Quote type that represents the subscription lifecycle stage such as New, Amendment, Renew or Cancel. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. | [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 subscription's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**project__ns** | **String** | The NetSuite project that the subscription was created from. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**sales_order__ns** | **String** | The NetSuite sales order than the subscription was created from. 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 subscription was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
 **account_key** | **String** | Customer account number or ID  | 
-**application_order** | **[String]** | The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.  **Note:**   - This field is valid only if the `applyCredit` field is set to `true`.   - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.   - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices.  | [optional] 
-**apply_credit** | **Boolean** | If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.   **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.  | [optional] 
-**apply_credit_balance** | **Boolean** | Whether to automatically apply a credit balance to an invoice.  If the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken.   To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.  Prerequisite: `invoice` must be `true`.   **Note:**    - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.   - This field is deprecated if you have the Invoice Settlement feature enabled.  | [optional] 
-**auto_renew** | **Boolean** | If true, this subscription automatically renews at the end of the subscription term.  This field is only required if the `termType` field is set to `TERMED`.  | [optional] [default to false]
-**collect** | **Boolean** | Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account.  If the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken.  Prerequisite: The `invoice` or `runBilling` field must be `true`.   **Note**: This field is only available if you set the `zuora-version` request header to `196.0` or later.  | [optional] 
+**application_order** | **[String]** | The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.   **Note:**   - This field is valid only if the `applyCredit` field is set to `true`.   - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.   - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices. | [optional] 
+**apply_credit** | **Boolean** | If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.    **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. | [optional] 
+**apply_credit_balance** | **Boolean** | Whether to automatically apply a credit balance to an invoice.   If the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken.    To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.   Prerequisite: `invoice` must be `true`.    **Note:**    - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.   - This field is deprecated if you have the Invoice Settlement feature enabled. | [optional] 
+**auto_renew** | **Boolean** | If true, this subscription automatically renews at the end of the subscription term.   This field is only required if the `termType` field is set to `TERMED`. | [optional] [default to false]
+**collect** | **Boolean** | Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account.   If the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken.   Prerequisite: The `invoice` or `runBilling` field must be `true`.    **Note**: This field is only available if you set the `zuora-version` request header to `196.0` or later. | [optional] 
 **contract_effective_date** | **String** | Effective contract date for this subscription, as yyyy-mm-dd  | 
 **credit_memo_reason_code** | **String** | A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code. | [optional] 
-**customer_acceptance_date** | **String** | The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd.  Default value is dependent on the value of other fields. See **Notes** section for more details.  | [optional] 
-**document_date** | **String** | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.  - If this field is specified, the specified date is used as the billing document date.  - If this field is not specified, the date specified in the `targetDate` is used as the billing document date.  | [optional] 
-**externally_managed_by** | **String** | An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.  | [optional] 
-**gateway_id** | **String** | The ID of the payment gateway instance. For example, `2c92c0f86078c4d5016091674bcc3e92`.  | [optional] 
-**initial_term** | **Number** | The length of the period for the first subscription term. If `termType` is `TERMED`, then this field is required, and the value must be greater than `0`. If `termType` is `EVERGREEN`, this field is ignored.  | [optional] 
-**initial_term_period_type** | **String** | The period type for the first subscription term.  This field is used with the `InitialTerm` field to specify the initial subscription term.  Values are:  * `Month` (default) * `Year` * `Day` * `Week`  | [optional] 
+**customer_acceptance_date** | **String** | The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd.   Default value is dependent on the value of other fields. See **Notes** section for more details. | [optional] 
+**document_date** | **String** | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.   - If this field is specified, the specified date is used as the billing document date.   - If this field is not specified, the date specified in the `targetDate` is used as the billing document date. | [optional] 
+**externally_managed_by** | **String** | An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores. | [optional] 
+**gateway_id** | **String** | The ID of the payment gateway instance. For example, `2c92c0f86078c4d5016091674bcc3e92`. | [optional] 
+**initial_term** | **Number** | The length of the period for the first subscription term. If `termType` is `TERMED`, then this field is required, and the value must be greater than `0`. If `termType` is `EVERGREEN`, this field is ignored. | [optional] 
+**initial_term_period_type** | **String** | The period type for the first subscription term.   This field is used with the `InitialTerm` field to specify the initial subscription term.   Values are:   * `Month` (default)  * `Year`  * `Day`  * `Week` | [optional] 
 **invoice** | **Boolean** | **Note:** This field has been replaced by the `runBilling` field. The `invoice` field is only available for backward compatibility.   Creates an invoice for a subscription. The invoice generated in this operation is only for this subscription, not for the entire customer account.   If the value is `true`, an invoice is created. If the value is `false`, no action is taken. The default value is `true`.    This field is in Zuora REST API version control. Supported minor versions are `196.0` and `207.0`. To use this field in the method, you must set the zuora-version parameter to the minor version number in the request header.  | [optional] 
-**invoice_collect** | **Boolean** | **Note:** This field has been replaced by the `invoice` field and the `collect` field. `invoiceCollect` is available only for backward compatibility.   If this field is set to `true`, an invoice is generated and payment collected automatically during the subscription process. If `false`, no invoicing or payment takes place. The invoice generated in this operation is only for this subscription, not for the entire customer account.   **Note**: This field is only available if you set the `zuora-version` request header to `186.0`, `187.0`, `188.0`, or `189.0`.  | [optional] 
-**invoice_owner_account_key** | **String** | Invoice owner account number or ID.  **Note:** 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] 
-**invoice_separately** | **Boolean** | Separates a single subscription from other subscriptions and invoices the charge independently.   If the value is `true`, the subscription is billed separately from other subscriptions. If the value is `false`, the subscription is included with other subscriptions in the account invoice.  The default value is `false`.  Prerequisite: The default subscription setting Enable Subscriptions to be Invoiced Separately must be set to Yes.  | [optional] 
+**invoice_collect** | **Boolean** | **Note:** This field has been replaced by the `invoice` field  and the `collect` field. `invoiceCollect` is available only for backward compatibility.    If this field is set to `true`, an invoice is generated and payment collected automatically  during the subscription process. If `false`, no invoicing or payment takes  place. The invoice generated in this operation is only for this subscription,  not for the entire customer account.    **Note**: This field is only available if you set the `zuora-version` request header to `186.0`, `187.0`, `188.0`, or `189.0`. | [optional] 
+**invoice_owner_account_key** | **String** | Invoice owner account number or ID.   **Note:** 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] 
+**invoice_separately** | **Boolean** | Separates a single subscription from other subscriptions and invoices the charge independently.    If the value is `true`, the subscription is billed separately from other subscriptions. If the value is `false`, the subscription is included with other subscriptions in the account invoice.   The default value is `false`.   Prerequisite: The default subscription setting Enable Subscriptions to be Invoiced Separately must be set to Yes. | [optional] 
 **invoice_target_date** | **String** | **Note:** This field has been replaced by the `targetDate` field. The `invoiceTargetDate` field is only available for backward compatibility.   Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.   This field is in Zuora REST API version control. Supported minor versions are `207.0` and earlier.  | [optional] 
-**last_booking_date** | **String** | The last booking date of the subscription object. This field is writable only when the subscription is newly created as a first version subscription. You can override the date value when creating a subscription through the Subscribe and Amend API or the subscription creation UI (non-Orders). Otherwise, the default value `today` is set per the user's timezone. The value of this field is as follows: * For a new subscription created by the [Subscribe and Amend APIs](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Migration_Guidance#Subscribe_and_Amend_APIs_to_Migrate), this field has the value of the subscription creation date. * For a subscription changed by an amendment, this field has the value of the amendment booking date. * For a subscription created or changed by an order, this field has the value of the order date.  | [optional] 
+**last_booking_date** | **String** | The last booking date of the subscription object. This field is writable only when the subscription is newly created as a first version subscription. You can override the date value when creating a subscription through the Subscribe and Amend API or the subscription creation UI (non-Orders). Otherwise, the default value `today` is set per the user's timezone. The value of this field is as follows:  * For a new subscription created by the [Subscribe and Amend APIs](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Migration_Guidance#Subscribe_and_Amend_APIs_to_Migrate), this field has the value of the subscription creation date.  * For a subscription changed by an amendment, this field has the value of the amendment booking date.  * For a subscription created or changed by an order, this field has the value of the order date.  | [optional] 
 **notes** | **String** | String of up to 500 characters.  | [optional] 
 **payment_method_id** | **String** | The ID of the payment method used for the payment.  | [optional] 
-**prepayment** | **Boolean** | Indicates whether the subscription will consume the reserved payment amount of the customer account. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.   | [optional] 
-**renewal_setting** | **String** | Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed.  Values:  * `RENEW_WITH_SPECIFIC_TERM` (default) * `RENEW_TO_EVERGREEN`  | [optional] 
-**renewal_term** | **Number** | The length of the period for the subscription renewal term. Default is `0`.  | 
-**renewal_term_period_type** | **String** | The period type for the subscription renewal term.  This field is used with the `renewalTerm` field to specify the subscription renewal term.  Values are:  * `Month` (default) * `Year` * `Day` * `Week`  | [optional] 
-**run_billing** | **Boolean** | Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos).     The billing documents generated in this operation is only for this subscription, not for the entire customer account.   Possible values:  - `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created.   - `false`: No invoice is created.   **Note:** This field is in Zuora REST API version control. Supported minor versions are `211.0` or later. To use this field in the method, you must set the `zuora-version` parameter to the minor version number in the request header.  | [optional] 
-**service_activation_date** | **String** | The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd.  Default value is dependent on the value of other fields. See **Notes** section for more details.  | [optional] 
+**prepayment** | **Boolean** | Indicates whether the subscription will consume the reserved payment amount of the customer account. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.  | [optional] 
+**renewal_setting** | **String** | Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed.   Values:   * `RENEW_WITH_SPECIFIC_TERM` (default)  * `RENEW_TO_EVERGREEN` | [optional] 
+**renewal_term** | **Number** | The length of the period for the subscription renewal term. Default is `0`. | 
+**renewal_term_period_type** | **String** | The period type for the subscription renewal term.   This field is used with the `renewalTerm` field to specify the subscription renewal term.   Values are:   * `Month` (default)  * `Year`  * `Day`  * `Week` | [optional] 
+**run_billing** | **Boolean** | Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos).      The billing documents generated  in this operation is only for this subscription, not for the entire  customer account.    Possible values:   - `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created.    - `false`: No invoice is created.    **Note:** This field is in Zuora REST API version control. Supported  minor versions are `211.0` or later. To use this field in the method,  you must set the `zuora-version` parameter to the minor version number  in the request header. | [optional] 
+**service_activation_date** | **String** | The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd.   Default value is dependent on the value of other fields. See **Notes** section for more details. | [optional] 
 **subscribe_to_rate_plans** | [**[CreateSubscriptionRatePlan]**](CreateSubscriptionRatePlan.md) | Container for one or more rate plans for this subscription.  | 
-**subscription_number** | **String** | Subscription Number. The value can be up to 1000 characters.  If you do not specify a subscription number when creating a subscription, Zuora will generate a subscription number automatically.  If the account is created successfully, the subscription number is returned in the `subscriptionNumber` response field.  | [optional] 
-**target_date** | **String** | Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date.   **Note:** The credit memo is only available if you have the Invoice Settlement feature enabled.   This field is in Zuora REST API version control. Supported minor versions are `211.0` and later. To use this field in the method, you must set the  `zuora-version` parameter to the minor version number in the request header.  | [optional] 
-**term_start_date** | **String** | The date on which the subscription term begins, as yyyy-mm-dd. If this is a renewal subscription, this date is different from the subscription start date.  | [optional] 
+**subscription_number** | **String** | Subscription Number. The value can be up to 1000 characters.   If you do not specify a subscription number when creating a subscription, Zuora will generate a subscription number automatically.   If the account is created successfully, the subscription number is returned in the `subscriptionNumber` response field. | [optional] 
+**target_date** | **String** | Date through which to calculate charges if an invoice or a credit memo is generated, as  yyyy-mm-dd. Default is current date.    **Note:** The credit memo is only available if you have the Invoice Settlement feature enabled.    This field is in Zuora REST API version control. Supported minor  versions are `211.0` and later. To use this field in the method, you  must set the  `zuora-version` parameter to the minor version number in  the request header. | [optional] 
+**term_start_date** | **String** | The date on which the subscription term begins, as yyyy-mm-dd. If this is a renewal subscription, this date is different from the subscription start date. | [optional] 
 **term_type** | **String** | Possible values are: `TERMED`, `EVERGREEN`.  | 
 
 

package/docs/CreateSubscriptionResponse.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **contracted_mrr** | **Number** | Monthly recurring revenue of the subscription.  | [optional] 
-**credit_memo_id** | **String** | The credit memo ID, if a credit memo is generated during the subscription process.  **Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later in the request header, and 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.  | [optional] 
+**credit_memo_id** | **String** | The credit memo ID, if a credit memo is generated during the subscription process.   **Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later in the request header, and 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. | [optional] 
 **invoice_id** | **String** | Invoice ID, if an invoice is generated during the subscription process.  | [optional] 
 **paid_amount** | **Number** | Payment amount, if a payment is collected.  | [optional] 
 **payment_id** | **String** | Payment ID, if a payment is collected.  | [optional] 

package/docs/CreateUpdateOpenPaymentMethodTypeResponse.md

@@ -5,8 +5,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **payment_method_type** | **String** | The API name of the custom payment method type.  | [optional] 
-**publish_date** | **String** | The date when the custom payment method type was published. It is empty if the custom payment method type has not been published yet.  | [optional] 
-**revision** | **Number** | The revision number of the custom payment method type, which starts from 1 and increases by 1 when you update a published revision for the first time.  | [optional] 
+**publish_date** | **String** | The date when the custom payment method type was published. It is empty if the custom payment method type has not been published yet. | [optional] 
+**revision** | **Number** | The revision number of the custom payment method type, which starts from 1 and increases by 1 when you update a published revision for the first time. | [optional] 
 **status** | **String** | The status of the custom payment method type.  | [optional] 
 
 

package/docs/CreateUpdateStoredCredentialProfileResponse.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**number** | **Number** | The number that identifies the stored credential profile within the payment method.  | [optional] 
+**number** | **Number** | The number that identifies the stored credential profile within the payment method. | [optional] 
 **payment_method_id** | **String** | ID of the payment method.  | [optional] 
 **success** | **Boolean** |  | [optional] 
 

package/docs/CreateUsageRequest.md

@@ -6,10 +6,10 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **account_id** | **String** |  The ID of the account associated with the usage data. This field is only required if no value is specified for the `AccountNumber` field. **Character limit**: 32 **Values**: a valid account ID. | [optional] 
 **account_number** | **String** |  The number of the account associated with the usage data. This field is only required if no value is specified for the `AccountId` field. **Character limit**: 50 **Values**: a valid account number. | [optional] 
-**subscription_id** | **String** | The original ID of the subscription that contains the fees related to the usage data.   The ID of a subscription might change when you create amendments to the subscription. It is good practice to use the unique subscription number that you can specify in the `SubscriptionNumber` field.  | [optional] 
-**subscription_number** | **String** | The unique identifier number of the subscription that contains the fees related to the usage data.  It is good practice to use this field when creating usage records.  | [optional] 
+**subscription_id** | **String** | The original ID of the subscription that contains the fees related to the usage data.    The ID of a subscription might change when you create amendments to the subscription. It is good practice to use the unique subscription number that you can specify in the `SubscriptionNumber` field. | [optional] 
+**subscription_number** | **String** | The unique identifier number of the subscription that contains the fees related to the usage data.   It is good practice to use this field when creating usage records. | [optional] 
 **charge_id** | **String** |  The OrginalId of the rate plan charge related to the usage record, e.g., `2c9081a03c63c94c013c6873357a0117` **Character limit**: 32 **Values**: a valid rate plan charge OriginalID.  | [optional] 
-**charge_number** | **String** | A unique number for the rate plan charge related to the usage record. For example, C-00000007.  | [optional] 
+**charge_number** | **String** | A unique number for the rate plan charge related to the usage record. For example, C-00000007. | [optional] 
 **start_date_time** | **Date** |  The start date and time of a range of time when usage is tracked. Zuora uses this field value to determine the usage date. Unlike the `EndDateTime`, the `StartDateTime` field does affect usage calculation. **Character limit**: 29 **Values**: a valid date and time value | 
 **end_date_time** | **Date** |  The end date and time of a range of time when usage is tracked. Use this field for reporting; this field doesn't affect usage calculation. **Character limit**: 29 **Values**: a valid date and time value. | [optional] 
 **UOM** | **String** |  Specifies the units to measure usage. Units of measure are configured in the web-based UI. Your values depend on your configuration in **Billing Settings**. **Character limit**: **Values**: a valid unit of measure | 

package/docs/CreditMemo.md

@@ -4,11 +4,11 @@
 
 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 credit memo's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**origin__ns** | **String** | Origin 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] 
-**sync_date__ns** | **String** | Date when the credit memo was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**transaction__ns** | **String** | Related transaction in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**integration_status__ns** | **String** | Status of the credit memo's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**origin__ns** | **String** | Origin 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] 
+**sync_date__ns** | **String** | Date when the credit memo was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**transaction__ns** | **String** | Related transaction in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
 **account_id** | **String** | The ID of the customer account associated with the credit memo. | [optional] 
 **account_number** | **String** | The number of the account associated with the credit memo. | [optional] 
 **amount** | **Number** | The total amount of the credit memo. | [optional] 

package/docs/CreditMemoItemFinanceInformation.md

@@ -4,15 +4,15 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**deferred_revenue_accounting_code** | **String** | The accounting code for the deferred revenue, such as Monthly Recurring Liability.  | [optional] 
-**deferred_revenue_accounting_code_type** | **String** | The type of the deferred revenue accounting code, such as Deferred Revenue.   | [optional] 
+**deferred_revenue_accounting_code** | **String** | The accounting code for the deferred revenue, such as Monthly Recurring Liability. | [optional] 
+**deferred_revenue_accounting_code_type** | **String** | The type of the deferred revenue accounting code, such as Deferred Revenue.  | [optional] 
 **on_account_accounting_code** | **String** | The accounting code that maps to an on account in your accounting system.  | [optional] 
-**on_account_accounting_code_type** | **String** | The type of the accounting code that maps to an on account in your accounting system.  | [optional] 
-**recognized_revenue_accounting_code** | **String** | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.  | [optional] 
-**non_revenue_write_off_accounting_code_type** | **String** | The type of the Non Revenue write-off accounting code, such as Bad Debt  | [optional] 
-**non_revenue_write_off_accounting_code** | **String** | The accounting code for the Non Revenue write-off accounting code, such as Bank Fee.  | [optional] 
-**recognized_revenue_accounting_code_type** | **String** | The type of the recognized revenue accounting code, such as Sales Revenue or Sales Discount.   | [optional] 
+**on_account_accounting_code_type** | **String** | The type of the accounting code that maps to an on account in your accounting system. | [optional] 
+**recognized_revenue_accounting_code** | **String** | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. | [optional] 
+**non_revenue_write_off_accounting_code_type** | **String** | The type of the Non Revenue write-off accounting code, such as Bad Debt | [optional] 
+**non_revenue_write_off_accounting_code** | **String** | The accounting code for the Non Revenue write-off accounting code, such as Bank Fee. | [optional] 
+**recognized_revenue_accounting_code_type** | **String** | The type of the recognized revenue accounting code, such as Sales Revenue or Sales Discount.  | [optional] 
 **revenue_recognition_rule_name** | **String** | The name of the revenue recognition rule governing the revenue schedule.  | [optional] 
-**revenue_schedule_number** | **String** | Revenue schedule number. The revenue schedule number is always prefixed with \"RS\", for example, RS-00000001.  | [optional] 
+**revenue_schedule_number** | **String** | Revenue schedule number. The revenue schedule number is always prefixed with \"RS\", for example, RS-00000001. | [optional] 
 
 

package/docs/CreditMemoItemFromChargeDetailFinanceInformation.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**deferred_revenue_accounting_code** | **String** | The accounting code for the deferred revenue, such as Monthly Recurring Liability.  | [optional] 
+**deferred_revenue_accounting_code** | **String** | The accounting code for the deferred revenue, such as Monthly Recurring Liability. | [optional] 
 **on_account_accounting_code** | **String** | The accounting code that maps to an on account in your accounting system.  | [optional] 
-**recognized_revenue_accounting_code** | **String** | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.  | [optional] 
+**recognized_revenue_accounting_code** | **String** | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. | [optional] 
 **revenue_recognition_rule_name** | **String** | The name of the revenue recognition rule governing the revenue schedule.  | [optional] 
 
 

package/docs/CreditMemoItemFromInvoiceItemFinanceInformation.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**deferred_revenue_accounting_code** | **String** | The accounting code for the deferred revenue, such as Monthly Recurring Liability.  | [optional] 
+**deferred_revenue_accounting_code** | **String** | The accounting code for the deferred revenue, such as Monthly Recurring Liability. | [optional] 
 **on_account_accounting_code** | **String** | The accounting code that maps to an on account in your accounting system.  | [optional] 
-**recognized_revenue_accounting_code** | **String** | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.  | [optional] 
+**recognized_revenue_accounting_code** | **String** | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. | [optional] 
 **revenue_recognition_rule_name** | **String** | The name of the revenue recognition rule governing the revenue schedule.  | [optional] 
 
 

package/docs/CreditMemoItemPart.md

@@ -6,15 +6,15 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **amount** | **Number** | The amount of the credit memo part item.  | [optional] 
 **created_by_id** | **String** | The ID of the Zuora user who created the credit memo part item.  | [optional] 
-**created_date** | **String** | The date and time when the credit memo part item was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.  | [optional] 
+**created_date** | **String** | The date and time when the credit memo part item was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. | [optional] 
 **credit_memo_item_id** | **String** | The ID of the credit memo item associated with the credit memo part item.  | [optional] 
 **credit_tax_item_id** | **String** | The ID of the credit memo taxation item.  | [optional] 
 **debit_memo_item_id** | **String** | The ID of the debit memo item associated with the credit memo part item.  | [optional] 
 **id** | **String** | The ID of the credit memo part item.  | [optional] 
 **invoice_item_id** | **String** | The ID of the invoice item associated with the credit memo part item.  | [optional] 
-**tax_item_id** | **String** | The ID of the invoice or debit memo taxation item associated with the credit memo taxation item.  | [optional] 
+**tax_item_id** | **String** | The ID of the invoice or debit memo taxation item associated with the credit memo taxation item. | [optional] 
 **updated_by_id** | **String** | The ID of the Zuora user who last updated the credit memo part item.  | [optional] 
-**updated_date** | **String** | The date and time when the credit memo part item was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.  | [optional] 
+**updated_date** | **String** | The date and time when the credit memo part item was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. | [optional] 
 **organization_label** | **String** | organizationLabel.  | [optional] 
 
 

package/docs/CreditMemoItemResponse.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
 **request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
 **reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
-**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **amount** | **Number** | The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax. | [optional] 
 **amount_without_tax** | **Number** | The credit memo item amount excluding tax. | [optional] 
 **applied_amount** | **Number** | The applied amount of the credit memo item. | [optional] 

package/docs/CreditMemoItemsResponse.md

@@ -7,8 +7,8 @@ Name | Type | Description | Notes
 **process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
 **request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
 **reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
-**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **items** | [**[CreditMemoItem]**](CreditMemoItem.md) | Container for credit memo items.  | [optional] 
-**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent.  | [optional] 
+**next_page** | **String** | URL to retrieve the next page of the response if it exists; otherwise absent. | [optional] 
 
 

package/docs/CreditMemoObjectNSFields.md

@@ -4,10 +4,10 @@
 
 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 credit memo's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**origin__ns** | **String** | Origin 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] 
-**sync_date__ns** | **String** | Date when the credit memo was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**transaction__ns** | **String** | Related transaction in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**integration_status__ns** | **String** | Status of the credit memo's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**origin__ns** | **String** | Origin 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] 
+**sync_date__ns** | **String** | Date when the credit memo was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**transaction__ns** | **String** | Related transaction in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
 
 

package/docs/CreditMemoPart.md

@@ -6,12 +6,12 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **amount** | **Number** | The amount of the credit memo part.  | [optional] 
 **created_by_id** | **String** | The ID of the Zuora user who created the credit memo part.  | [optional] 
-**created_date** | **String** | The date and time when the credit memo part was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.  | [optional] 
+**created_date** | **String** | The date and time when the credit memo part was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. | [optional] 
 **debit_memo_id** | **String** | The ID of the debit memo associated with the credit memo part.  | [optional] 
 **id** | **String** | The ID of the credit memo part.  | [optional] 
 **invoice_id** | **String** | The ID of the invoice associated with the credit memo part.  | [optional] 
 **updated_by_id** | **String** | The ID of the Zuora user who last updated the credit memo part.  | [optional] 
-**updated_date** | **String** | The date and time when the credit memo part was last upated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.  | [optional] 
+**updated_date** | **String** | The date and time when the credit memo part was last upated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. | [optional] 
 **organization_label** | **String** | organizationLabel.  | [optional] 
 
 

package/docs/CreditMemoResponse.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
 **request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
 **reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
-**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **account_id** | **String** | The ID of the customer account associated with the credit memo. | [optional] 
 **account_number** | **String** | The number of the account associated with the credit memo. | [optional] 
 **amount** | **Number** | The total amount of the credit memo. | [optional] 
@@ -55,10 +55,10 @@ Name | Type | Description | Notes
 **bill_to_contact_snapshot_id** | **String** | billToContactSnapshotId.  | [optional] 
 **organization_label** | **String** | organization label.  | [optional] 
 **communication_profile_id** | **String** | The ID of the communication profile associated with the credit memo. | [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 credit memo's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**origin__ns** | **String** | Origin 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] 
-**sync_date__ns** | **String** | Date when the credit memo was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
-**transaction__ns** | **String** | Related transaction in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).  | [optional] 
+**integration_id__ns** | **String** | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**integration_status__ns** | **String** | Status of the credit memo's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**origin__ns** | **String** | Origin 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] 
+**sync_date__ns** | **String** | Date when the credit memo was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional] 
+**transaction__ns** | **String** | Related transaction in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). | [optional]