zuora-sdk-js 3.6.0 → 3.7.0

package/docs/OpenPaymentMethodTypeRequestFields.md

@@ -9,13 +9,13 @@ Name | Type | Description | Notes
 **description** | **String** | An explanation of this field. It can be an empty string.  | [optional] 
 **editable** | **Boolean** | Specify `true` if this field can be updated through PUT API or UI.  This field cannot be `null` or empty.  Note: If `editable` is set to `false`, you can specify the value of this field in the UI and POST API when creating a payment method. However, after you created the payment method, you cannot edit this field through PUT API or UI.  | [optional] 
 **index** | **Number** | The order of the field in this type, starting from 1. It must be unique.  This field cannot be `null` or empty.  This field cannot be updated after the creation of the custom payment method type.  | [optional] 
-**label** | **String** | The label that is used to refer to this field in the Zuora UI.  An alphanumeric string, excluding JSON preserved characters e.g.  * \\ ’ ”  This field cannot be `null` or empty or any reserved field name.  | [optional] 
+**label** | **String** | The label that is used to refer to this field in the Zuora UI.  nAn alphanumeric string, excluding JSON preserved characters e.g.  * \\ ’ ”  This field cannot be `null` or empty or any reserved field name.  | [optional] 
 **max_length** | **Number** | A maximum length limitation of the field value. The specified value must be in the range of [1,8000]. `maxLength` must be greater than or equal to `minLength`.  After the custom payment method type is created, you can only increase the value of `maxLength`. Decreasing the value is not supported.  | [optional] 
 **min_length** | **Number** | A minimal length limitation of the field value.      0 <= `minLength` <= `maxLength`  The value of this metadata does not determine whether the field is a required field. It only defines the minimal length of the field value.  After the custom payment method type is created, you can only decrease the value of `minLength`. Increasing the value is not supported.  | [optional] 
 **name** | **String** | The API name of this field. It must be uinique.  An alphanumeric string starting with a capital letter, excluding JSON preserved characters e.g.  * \\ ’ ”  Though this field must be defined with a string starting with a capital letter, use this string with the first letter in lowercase when you specify it in other API operations. For example, `AmazonPayToken` is the defined value for `name`. In the request of the \"Create a payment method\" API operation, use `amazonPayToken`.  This field cannot be `null` or empty or any reserved field name.  This field cannot be updated after the creation of the custom payment method type.  | [optional] 
-**representer** | **Boolean** | This flag determines whether this field will be used for identifying this payment method in the Zuora UI. The field will be shown in the Payment Method field in the UI.  This field cannot be `null` or empty.  Notes:   - In one custom payment method type, set `representer` to `true` for at least one field .   - In one custom payment method type, you can set `representer` to `true` for multiple fields.  | [optional] 
+**representer** | **Boolean** | This flag determines whether this field will be used for identifying this payment method in the Zuora UI. The field will be shown in the Payment Method field in the UI.  This field cannot be `null` or empty.  Notes:  - In one custom payment method type, set `representer` to `true` for at least one field .   - In one custom payment method type, you can set `representer` to `true` for multiple fields.  | [optional] 
 **required** | **Boolean** | Specify whether this field is required.  This field cannot be `null` or empty.  This field cannot be updated after the creation of the custom payment method type.  | [optional] 
 **type** | [**OpenPaymentMethodTypeFieldsType**](OpenPaymentMethodTypeFieldsType.md) |  | [optional] 
-**visible** | **Boolean** | Specify `true` if this field can be retrieved through GET API or UI for displaying payment method details.  This field cannot be `null` or empty.  Notes:    - If `visible` is set to `false`, you can still specify the value of this field in the UI and POST API when creating the payment method.   - If `visible` is set to `false` and `editable` is set to `true`, this field is not accessible through GET API or UI for displaying details, but you can still see it and edit the value in the UI and PUT API when updating this payment method.  | [optional] 
+**visible** | **Boolean** | Specify `true` if this field can be retrieved through GET API or UI for displaying payment method details.  This field cannot be `null` or empty.  Notes:    - If `visible` is set to `false`, you can still specify the value of this field in the UI and POST API when creating the payment method.  - If `visible` is set to `false` and `editable` is set to `true`, this field is not accessible through GET API or UI for displaying details, but you can still see it and edit the value in the UI and PUT API when updating this payment method.  | [optional] 
 
 

package/docs/OpenPaymentMethodTypeResponse.md

@@ -4,16 +4,16 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**entity_id** | **String** | If an entity UUID is provided, this custom payment method type is specific to this entity only. If no entity UUID is provided, the custom payment method type is available to the global entity and all the sub entities in the tenant.  | [optional] 
+**entity_id** | **String** | If an entity UUID is provided, this custom payment method type is specific to this entity only. If no entity UUID is provided, the custom payment method type is available to the global entity and all the sub entities in the tenant. | [optional] 
 **fields** | [**[OpenPaymentMethodTypeResponseFields]**](OpenPaymentMethodTypeResponseFields.md) | An array containing field metadata of the custom payment method type.  | [optional] 
-**internal_name** | **String** | A string to identify the custom payment method type in the API name of the payment method type.  This field is used along with the `tenantId` field by the system to construct and generate the API name of the custom payment method type in the following way:  `<internalName>__c_<tenantId>`  For example, if `internalName` is `AmazonPay`, and `tenantId` is `12368`, the API name of the custom payment method type will be `AmazonPay__c_12368`.  | [optional] 
+**internal_name** | **String** | A string to identify the custom payment method type in the API name of the payment method type.   This field is used along with the `tenantId` field by the system to construct and generate the API name of the custom payment method type in the following way:   `<internalName>__c_<tenantId>`   For example, if `internalName` is `AmazonPay`, and `tenantId` is `12368`, the API name of the custom payment method type will be `AmazonPay__c_12368`. | [optional] 
 **label** | **String** | The label that is used to refer to this type in the Zuora UI.  | [optional] 
-**method_reference_id_field** | **String** | The identification reference of the custom payment method.  This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.  | [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] 
+**method_reference_id_field** | **String** | The identification reference of the custom payment method.   This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query. | [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] 
-**sub_type_field** | **String** | The identification reference indicating the subtype of the custom payment method.  This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.  | [optional] 
-**tenant_id** | **String** | Zuora tenant ID. If multi-entity is enabled in your tenant, this is the ID of the parent tenant of all the sub entities.  | [optional] 
-**user_reference_id_field** | **String** | The identification reference of the user or customer account.  This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.  | [optional] 
+**sub_type_field** | **String** | The identification reference indicating the subtype of the custom payment method.   This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query. | [optional] 
+**tenant_id** | **String** | Zuora tenant ID. If multi-entity is enabled in your tenant, this is the ID of the parent tenant of all the sub entities. | [optional] 
+**user_reference_id_field** | **String** | The identification reference of the user or customer account.   This field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query. | [optional] 
 **version** | **String** | The time when the custom payment method type was first published.  | [optional] 
 
 

package/docs/OperationJobResponse.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **process_id** | **String** | The Id of the process that handle the operation.  | [optional] 
 **request_id** | **String** | Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.  | [optional] 
 **reasons** | [**[FailedReason]**](FailedReason.md) |  | [optional] 
-**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] 
+**success** | **Boolean** | Indicates whether the call succeeded.  | [optional] [default to true]
 **id** | **String** | The ID of the operation job to retrieve information about. | [optional] 
 **object_id** | **String** | The ID of the business object which is being operated. | [optional] 
 **object_type** | [**OperationJobObjectType**](OperationJobObjectType.md) |  | [optional] 

package/docs/OperationsApi.md

@@ -150,7 +150,7 @@ Name | Type | Description  | Notes
 
 Invoice and collect
 
-Generates and posts invoices and credit memos and collects payments for posted invoices. Credit memos are only available if you have the Invoice Settlement feature enabled and negative charges exist. Credit memos will not be applied to invoices. If draft invoices and credit memos exist when you run this operation, this operation will post the invoices and credit memos. Note that draft credit memos created from an invoice or a product rate plan charge will not be posted.  You can use this operation to generate invoices and collect payments on the posted invoices,  or else simply collect payment on a specified existing invoice. The customer's default payment method is used, and the full amount due is collected. The operation depends on the parameters you specify.  - To generate one or more new invoices for that customer and collect payment on the generated and other unpaid invoice(s), leave the **invoiceId** field empty.   - To collect payment on an existing invoice, specify the invoice ID.    The operation is atomic; if any part is unsuccessful, the entire operation is rolled back.  When an error occurs, gateway reason codes and error messages are returned the error response of this operation. The following items are some gateway response code examples.  - Orbital: `05 Do Not Honor`; `14 Invalid Credit Card Number` - Vantiv: `301 Invalid Account Number`; `304 Lost/Stolen Card`   - CyberSource2: `202 Expired card`; `231 Invalid account number`  For more reason code information, see the corresponding payment gateway documentation.    ### Notes  Timeouts may occur when using this method on an account that has an extremely high number of subscriptions. 
+Generates and posts invoices and credit memos and collects payments for posted invoices. Credit memos are only available if you have the Invoice Settlement feature enabled and negative charges exist. Credit memos will not be applied to invoices. If draft invoices and credit memos exist when you run this operation, this operation will post the invoices and credit memos. Note that draft credit memos created from an invoice or a product rate plan charge will not be posted.  You can use this operation to generate invoices and collect payments on the posted invoices,  or else simply collect payment on a specified existing invoice. The customer's default payment method is used, and the full amount due is collected. The operation depends on the parameters you specify. n- To generate one or more new invoices for that customer and collect payment on the generated and other unpaid invoice(s), leave the **invoiceId** field empty.   - To collect payment on an existing invoice, specify the invoice ID.    The operation is atomic; if any part is unsuccessful, the entire operation is rolled back.  When an error occurs, gateway reason codes and error messages are returned the error response of this operation. The following items are some gateway response code examples.  - Orbital: `05 Do Not Honor`; `14 Invalid Credit Card Number` - Vantiv: `301 Invalid Account Number`; `304 Lost/Stolen Card`   - CyberSource2: `202 Expired card`; `231 Invalid account number`  For more reason code information, see the corresponding payment gateway documentation.    ### Notes  Timeouts may occur when using this method on an account that has an extremely high number of subscriptions. 
 
 ### Example
 
@@ -292,7 +292,7 @@ let bearerAuth = defaultClient.authentications['bearerAuth'];
 bearerAuth.accessToken = "YOUR ACCESS TOKEN"
 
 let apiInstance = new ZuoraSdkJs.OperationsApi();
-let job_id = "job_id_example"; // String | The ID of the operation job to retrieve information about. For example, 2c92c8955bd63cc1015bd7c151af02ab. 
+let job_id = "job_id_example"; // String | The ID of the operation job to retrieve information about. For example, 2c92c8955bd63cc1015bd7c151af02ab.
 let opts = {
   'accept_encoding': "accept_encoding_example", // String | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. 
   'content_encoding': "content_encoding_example", // String | Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. 
@@ -315,7 +315,7 @@ apiInstance.getOperationJob(job_id, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **job_id** | **String**| The ID of the operation job to retrieve information about. For example, 2c92c8955bd63cc1015bd7c151af02ab.  | 
+ **job_id** | **String**| The ID of the operation job to retrieve information about. For example, 2c92c8955bd63cc1015bd7c151af02ab. | 
  **accept_encoding** | **String**| Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.   If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.  | [optional] 
  **content_encoding** | **String**| Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.  | [optional] 
  **authorization** | **String**| The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://www.zuora.com/developer/api-references/api/operation/createToken).  | [optional] 

package/docs/OrderActionCreateSubscription.md

@@ -4,18 +4,18 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**bill_to_contact_id** | **String** | The ID of the bill-to contact associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
+**bill_to_contact_id** | **String** | The ID of the bill-to contact associated with the subscription.  n**Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
 **communication_profile_id** | **String** | The ID of the communication profile associated with the subscription.               **Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature enabled.  | [optional] 
 **invoice_group_number** | **String** | The number of invoice group associated with the subscription.  **Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature enabled.  | [optional] 
 **invoice_separately** | **Boolean** | Specifies whether the subscription appears on a separate invoice when Zuora generates invoices.  | [optional] 
-**invoice_template_id** | **String** | The ID of the invoice template associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
+**invoice_template_id** | **String** | The ID of the invoice template associated with the subscription.  n**Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
 **new_subscription_owner_account** | [**CreateOrderSubscriptionOwnerAccount**](CreateOrderSubscriptionOwnerAccount.md) |  | [optional] 
 **notes** | **String** | Notes about the subscription. These notes are only visible to Zuora users.  | [optional] 
-**payment_term** | **String** | The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
+**payment_term** | **String** | The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.  n**Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
 **sequence_set_id** | **String** | The ID of the sequence set associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
-**sold_to_contact_id** | **String** | The ID of the sold-to contact associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
+**sold_to_contact_id** | **String** | The ID of the sold-to contact associated with the subscription.  n**Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
 **ship_to_contact_id** | **String** | The ID of the ship-to contact associated with the subscription. | [optional] 
-**subscribe_to_products** | [**[SubscribeToProduct]**](SubscribeToProduct.md) | For a rate plan, the following fields are available:   - `chargeOverrides`   - `clearingExistingFeatures`   - `customFields`   - `externallyManagedPlanId`   - `newRatePlanId`   - `productRatePlanId`   - `subscriptionProductFeatures`   - `uniqueToken`     | [optional] 
+**subscribe_to_products** | [**[SubscribeToProduct]**](SubscribeToProduct.md) | For a rate plan, the following fields are available:   - `chargeOverrides`  - `clearingExistingFeatures`   - `customFields`   - `externallyManagedPlanId`  - `newRatePlanId`   - `productRatePlanId`   - `subscriptionProductFeatures`  - `uniqueToken`     | [optional] 
 **subscribe_to_rate_plans** | [**[RatePlanOverride]**](RatePlanOverride.md) | List of rate plans associated with the subscription.  **Note**: The `subscribeToRatePlans` field has been deprecated, this field is replaced by the `subscribeToProducts` field that supports Rate Plans. In a new order request, you can use either `subscribeToRatePlans` or `subscribeToProducts`, not both.  | [optional] 
 **subscription_number** | **String** | Subscription number of the subscription. For example, A-S00000001.  If you do not set this field, Zuora will generate the subscription number.  | [optional] 
 **subscription_owner_account_number** | **String** | Account number of an existing account that will own the subscription. For example, A00000001.  If you do not set this field or the `newSubscriptionOwnerAccount` field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the `newSubscriptionOwnerAccount` field.  | [optional] 

package/docs/OrderActionOwnerTransfer.md

@@ -4,24 +4,24 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**bill_to_contact_id** | **String** | The contact id of the bill to contact that the subscription is being transferred to.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
-**clearing_existing_bill_to_contact** | **Boolean** | Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the `billToContactId` field.  **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.  | [optional] [default to false]
-**clearing_existing_invoice_group_number** | **Boolean** | Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the `invoiceGroupNumber` field.  **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.  | [optional] [default to false]
-**clearing_existing_invoice_template** | **Boolean** | Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the `invoiceTemplateId` field.  **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.  | [optional] [default to false]
-**clearing_existing_payment_term** | **Boolean** | Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the `paymentTerm` field.  **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.  | [optional] [default to false]
-**clearing_existing_sequence_set** | **Boolean** | Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the `sequenceSetId` field.  **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.  | [optional] [default to false]
-**clearing_existing_sold_to_contact** | **Boolean** | Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the `soldToContactId` field.  **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.  | [optional] [default to false]
-**destination_account_number** | **String** | The account number of the account that the subscription is being transferred to.  | [optional] 
-**destination_invoice_account_number** | **String** | The account number of the invoice owner account that the subscription is being transferred to.  | [optional] 
+**bill_to_contact_id** | **String** | The contact id of the bill to contact that the subscription is being transferred to.   **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. | [optional] 
+**clearing_existing_bill_to_contact** | **Boolean** | Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the `billToContactId` field.   **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. | [optional] [default to false]
+**clearing_existing_invoice_group_number** | **Boolean** | Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the `invoiceGroupNumber` field.   **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. | [optional] [default to false]
+**clearing_existing_invoice_template** | **Boolean** | Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the `invoiceTemplateId` field.   **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. | [optional] [default to false]
+**clearing_existing_payment_term** | **Boolean** | Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the `paymentTerm` field.   **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. | [optional] [default to false]
+**clearing_existing_sequence_set** | **Boolean** | Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the `sequenceSetId` field.   **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. | [optional] [default to false]
+**clearing_existing_sold_to_contact** | **Boolean** | Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the `soldToContactId` field.   **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. | [optional] [default to false]
+**destination_account_number** | **String** | The account number of the account that the subscription is being transferred to. | [optional] 
+**destination_invoice_account_number** | **String** | The account number of the invoice owner account that the subscription is being transferred to. | [optional] 
 **invoice_group_number** | **String** | The number of invoice group associated with the subscription.  **Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature enabled.  | [optional] 
 **invoice_template_id** | **String** | The ID of the invoice template associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
-**payment_term** | **String** | Name of the payment term associated with the account. For example, \"Net 30\". The payment term determines the due dates of invoices.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
+**payment_term** | **String** | Name of the payment term associated with the account. For example, \"Net 30\". The payment term determines the due dates of invoices.   **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. | [optional] 
 **sequence_set_id** | **String** | The ID of the sequence set associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
 **sold_to_contact_id** | **String** | The ID of the sold-to contact associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
 **ship_to_contact_id** | **String** | The ID of the ship-to contact associated with the subscription.  | [optional] 
-**clearing_existing_ship_to_contact** | **Boolean** | Whether to clear the existing ship-to contact ID at the subscription level. This field is mutually exclusive with the `shipToContactId` field.  | [optional] 
+**clearing_existing_ship_to_contact** | **Boolean** | Whether to clear the existing ship-to contact ID at the subscription level. This field is mutually exclusive with the `shipToContactId` field. | [optional] 
 **payment_profile** | [**PaymentProfile**](PaymentProfile.md) |  | [optional] 
 **communication_profile_id** | **String** | The ID of the communication profile associated with the subscription.  **Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature enabled.  | [optional] 
-**clearing_existing_communication_profile** | **Boolean** | Whether to clear the existing communication profile at the subscription level. This field is mutually exclusive with the `communicationProfileId` field.  | [optional] 
+**clearing_existing_communication_profile** | **Boolean** | Whether to clear the existing communication profile at the subscription level. This field is mutually exclusive with the `communicationProfileId` field. | [optional] 
 
 

package/docs/OrderActionRatePlanAmendment.md

@@ -5,10 +5,10 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **String** | The amendment code.  | [optional] 
-**contract_effective_date** | **String** | The date when the amendment becomes effective for billing purposes, as `yyyy-mm-dd`.  | [optional] 
+**contract_effective_date** | **String** | The date when the amendment becomes effective for billing purposes, as `yyyy-mm-dd`. | [optional] 
 **created_by** | **String** | The ID of the user who created this amendment.  | [optional] 
 **created_date** | **String** | The time that the amendment gets created in the system, in the `YYYY-MM-DD HH:MM:SS` format. | [optional] 
-**customer_acceptance_date** | **String** | The date when the customer accepts the amendment changes to the subscription, as `yyyy-mm-dd`.  | [optional] 
+**customer_acceptance_date** | **String** | The date when the customer accepts the amendment changes to the subscription, as `yyyy-mm-dd`. | [optional] 
 **description** | **String** | Description of the amendment.  | [optional] 
 **effective_date** | **String** | The date when the amendment changes take effective.   | [optional] 
 **id** | **String** | The amendment ID.  | [optional] 

package/docs/OrderActionRatePlanChargeModelDataOverride.md

@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **charge_model_configuration** | [**ChargeModelConfigurationForSubscription**](ChargeModelConfigurationForSubscription.md) |  | [optional] 
-**tiers** | [**[ChargeTier]**](ChargeTier.md) | List of cumulative pricing tiers in the charge.  **Note**: When you override tiers of the charge with a High Water Mark Pricing charge model, you have to provide all of the tiers, including the ones you do not want to change. The new tiers will completely override the previous ones. The High Water Mark Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.  | [optional] 
+**tiers** | [**[ChargeTier]**](ChargeTier.md) | List of cumulative pricing tiers in the charge.   **Note**: When you override tiers of the charge with a High Water Mark Pricing charge model, you have to provide all of the tiers, including the ones you do not want to change. The new tiers will completely override the previous ones. The High Water Mark Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information. | [optional] 
 
 

package/docs/OrderActionRatePlanChargeRemove.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **charge_number** | **String** | Read only. Identifies the charge to be updated.  | [optional] 
 **product_rate_plan_charge_id** | **String** | Identifier of the rate plan that was updated.  | [optional] 
 **product_rate_plan_number** | **String** | Number of a product rate plan for this subscription.  | [optional] 
-**unique_token** | **String** | A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, you would assign a unique token to the product rate plan when added and use that token in future order actions.  | [optional] 
+**unique_token** | **String** | A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, you would assign a unique token to the product rate plan when added and use that token in future order actions. | [optional] 
 **custom_fields** | **{String: Object}** | Container for custom fields of a Rate Plan Charge object.  | [optional] 
 
 

package/docs/OrderActionRatePlanChargeUpdate.md

@@ -11,6 +11,6 @@ Name | Type | Description | Notes
 **effective_date** | [**TriggerParams**](TriggerParams.md) |  | [optional] 
 **estimated_start_date** | **String** | **Note**: This field is only available if you have the [Pending Charge Flexibility] (https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Pending_Charge_Flexibility). feature enabled. Estimated Start Date of the charge. | [optional] 
 **pricing** | [**OrderActionRatePlanPricingUpdate**](OrderActionRatePlanPricingUpdate.md) | Pricing information about the charge.  | [optional] 
-**unique_token** | **String** | A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, you would assign a unique token to the product rate plan when added and use that token in future order actions.  | [optional] 
+**unique_token** | **String** | A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, you would assign a unique token to the product rate plan when added and use that token in future order actions. | [optional] 
 
 

package/docs/OrderActionRatePlanOverride.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **charge_overrides** | [**[OrderActionRatePlanChargeOverride]**](OrderActionRatePlanChargeOverride.md) | List of charges associated with the rate plan.  | [optional] 
 **custom_fields** | **{String: Object}** | Container for custom fields of a Rate Plan object.  | [optional] 
 **new_rate_plan_id** | **String** | Internal identifier of the rate plan.  | [optional] 
-**product_rate_plan_id** | **String** | Internal identifier of the product rate plan that the rate plan is based on.  | 
-**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] 
+**product_rate_plan_id** | **String** | Internal identifier of the product rate plan that the rate plan is based on. | 
+**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] 
 
 

package/docs/OrderActionRatePlanPricingUpdate.md

@@ -6,16 +6,16 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **charge_model_data** | [**OrderActionRatePlanChargeModelDataOverride**](OrderActionRatePlanChargeModelDataOverride.md) | Container for charge model configuration data.  | [optional] 
 **discount** | [**DiscountPricingUpdate**](DiscountPricingUpdate.md) | Pricing information about a discount charge.  | [optional] 
-**recurring_delivery** | [**OrderActionRatePlanRecurringDeliveryPricingUpdate**](OrderActionRatePlanRecurringDeliveryPricingUpdate.md) | Pricing information about a recurring charge that uses the Delivery Pricing charge model. In this charge model, the charge has a fixed price. This field is only available if you have the Delivery Pricing charge model enabled.  **Note**: The Delivery Pricing charge model 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 <a href=\"http://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>.  | [optional] 
-**recurring_flat_fee** | [**RecurringFlatFeePricingUpdate**](RecurringFlatFeePricingUpdate.md) | Pricing information about a recurring charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.  | [optional] 
-**recurring_per_unit** | [**RecurringPerUnitPricingUpdate**](RecurringPerUnitPricingUpdate.md) | Pricing information about a recurring charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased.  | [optional] 
-**recurring_tiered** | [**RecurringTieredPricingUpdate**](RecurringTieredPricingUpdate.md) | Pricing information about a recurring charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.  | [optional] 
-**recurring_volume** | [**RecurringVolumePricingUpdate**](RecurringVolumePricingUpdate.md) | Pricing information about a recurring charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.  | [optional] 
-**usage_flat_fee** | [**UsageFlatFeePricingUpdate**](UsageFlatFeePricingUpdate.md) | Pricing information about a usage charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.  | [optional] 
-**usage_overage** | [**UsageOveragePricingUpdate**](UsageOveragePricingUpdate.md) | Pricing information about a usage charge that uses the \"overage\" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed.  | [optional] 
-**usage_per_unit** | [**UsagePerUnitPricingUpdate**](UsagePerUnitPricingUpdate.md) | Pricing information about a usage charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit consumed.  | [optional] 
-**usage_tiered** | [**UsageTieredPricingUpdate**](UsageTieredPricingUpdate.md) | Pricing information about a usage charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed.  | [optional] 
-**usage_tiered_with_overage** | [**UsageTieredWithOveragePricingUpdate**](UsageTieredWithOveragePricingUpdate.md) | Pricing information about a usage charge that uses the \"tiered with overage\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier.  | [optional] 
-**usage_volume** | [**UsageVolumePricingUpdate**](UsageVolumePricingUpdate.md) | Pricing information about a usage charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed.  | [optional] 
+**recurring_delivery** | [**OrderActionRatePlanRecurringDeliveryPricingUpdate**](OrderActionRatePlanRecurringDeliveryPricingUpdate.md) | Pricing information about a recurring charge that uses the Delivery Pricing charge model. In this charge model, the charge has a fixed price. This field is only available if you have the Delivery Pricing charge model enabled.   **Note**: The Delivery Pricing charge model 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 <a href=\"http://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>. | [optional] 
+**recurring_flat_fee** | [**RecurringFlatFeePricingUpdate**](RecurringFlatFeePricingUpdate.md) | Pricing information about a recurring charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price. | [optional] 
+**recurring_per_unit** | [**RecurringPerUnitPricingUpdate**](RecurringPerUnitPricingUpdate.md) | Pricing information about a recurring charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased. | [optional] 
+**recurring_tiered** | [**RecurringTieredPricingUpdate**](RecurringTieredPricingUpdate.md) | Pricing information about a recurring charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased. | [optional] 
+**recurring_volume** | [**RecurringVolumePricingUpdate**](RecurringVolumePricingUpdate.md) | Pricing information about a recurring charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased. | [optional] 
+**usage_flat_fee** | [**UsageFlatFeePricingUpdate**](UsageFlatFeePricingUpdate.md) | Pricing information about a usage charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price. | [optional] 
+**usage_overage** | [**UsageOveragePricingUpdate**](UsageOveragePricingUpdate.md) | Pricing information about a usage charge that uses the \"overage\" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed. | [optional] 
+**usage_per_unit** | [**UsagePerUnitPricingUpdate**](UsagePerUnitPricingUpdate.md) | Pricing information about a usage charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit consumed. | [optional] 
+**usage_tiered** | [**UsageTieredPricingUpdate**](UsageTieredPricingUpdate.md) | Pricing information about a usage charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. | [optional] 
+**usage_tiered_with_overage** | [**UsageTieredWithOveragePricingUpdate**](UsageTieredWithOveragePricingUpdate.md) | Pricing information about a usage charge that uses the \"tiered with overage\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier. | [optional] 
+**usage_volume** | [**UsageVolumePricingUpdate**](UsageVolumePricingUpdate.md) | Pricing information about a usage charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed. | [optional] 
 
 

package/docs/OrderActionRatePlanRecurringFlatFeePricingOverride.md

@@ -8,6 +8,6 @@ Name | Type | Description | Notes
 **price_increase_percentage** | **Number** | Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`.  | [optional] 
 **list_price** | **Number** | Price of the charge in each recurring period.  | [optional] 
 **list_price_base** | [**ChargeListPriceBase**](ChargeListPriceBase.md) |  | [optional] 
-**specific_list_price_base** | **Number** | The number of months for the list price base of the charge. The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.  | [optional] 
+**specific_list_price_base** | **Number** | The number of months for the list price base of the charge. The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`. | [optional] 
 
 

package/docs/OrderActionRatePlanRecurringPerUnitPricingOverride.md

@@ -9,6 +9,6 @@ Name | Type | Description | Notes
 **list_price** | **Number** | Per-unit price of the charge in each recurring period.  | [optional] 
 **list_price_base** | [**ChargeListPriceBase**](ChargeListPriceBase.md) |  | [optional] 
 **quantity** | **Number** | Number of units purchased.  | [optional] 
-**specific_list_price_base** | **Number** | The number of months for the list price base of the charge. This field is required if you set the value of the `listPriceBase` field to `Per_Specific_Months`.  | [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`. | [optional] 
 
 

package/docs/OrderActionRatePlanRecurringTieredPricingOverride.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **price_increase_percentage** | **Number** | Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`.  | [optional] 
 **list_price_base** | [**ChargeListPriceBase**](ChargeListPriceBase.md) |  | [optional] 
 **quantity** | **Number** | Number of units purchased.  | [optional] 
-**specific_list_price_base** | **Number** | The number of months for the list price base of the charge. This field is required if you set the value of the `listPriceBase` field to `Per_Specific_Months`.  | [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`. | [optional] 
 **tiers** | [**[ChargeTier]**](ChargeTier.md) | List of cumulative pricing tiers in the charge.  | [optional] 
 
 

package/docs/OrderActionRatePlanRecurringVolumePricingOverride.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **price_increase_percentage** | **Number** | Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`.  | [optional] 
 **list_price_base** | [**ChargeListPriceBase**](ChargeListPriceBase.md) |  | [optional] 
 **quantity** | **Number** | Number of units purchased.  | [optional] 
-**specific_list_price_base** | **Number** | The number of months for the list price base of the charge. This field is required if you set the value of the `listPriceBase` field to `Per_Specific_Months`.  | [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`. | [optional] 
 **tiers** | [**[ChargeTier]**](ChargeTier.md) | List of variable pricing tiers in the charge.  | [optional] 
 
 

package/docs/OrderActionRatePlanUpdate.md

@@ -6,9 +6,9 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **charge_updates** | [**[OrderActionRatePlanChargeUpdate]**](OrderActionRatePlanChargeUpdate.md) |  | [optional] 
 **custom_fields** | **{String: Object}** | Container for custom fields of a Rate Plan object.  | [optional] 
-**new_rate_plan_id** | **String** | Internal identifier of the updated rate plan in the new subscription version.  | [optional] 
+**new_rate_plan_id** | **String** | Internal identifier of the updated rate plan in the new subscription version. | [optional] 
 **rate_plan_id** | **String** | Internal identifier of the rate plan that was updated.  | [optional] 
 **specific_update_date** | **String** |  The date when the Update Product order action takes effect. This field is only applicable if there is already a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd.  See [Update a Product on Subscription with Future-dated Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates) for more information about this feature.  | [optional] 
-**unique_token** | **String** | A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, you would assign a unique token to the product rate plan when added and use that token in future order actions.  | [optional] 
+**unique_token** | **String** | A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, you would assign a unique token to the product rate plan when added and use that token in future order actions. | [optional] 
 
 

package/docs/OrderActionRemoveProduct.md

@@ -4,10 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**external_catalog_plan_id** | **String** | An external ID of the rate plan to be removed. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to remove the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.  **Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.  | [optional] 
+**external_catalog_plan_id** | **String** | An external ID of the rate plan to be removed. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to remove the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.   **Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. | [optional] 
 **product_rate_plan_number** | **String** | Number of a product rate plan for this subscription.  | [optional] 
 **product_rate_plan_id** | **String** | ID of a product rate plan for this subscription.  | [optional] 
-**rate_plan_id** | **String** | ID of the rate plan to remove. This can be the latest version or any history version of ID.  | [optional] 
+**rate_plan_id** | **String** | ID of the rate plan to remove. This can be the latest version or any history version of ID. | [optional] 
 **subscription_rate_plan_number** | **String** | Number of a rate plan for this subscription.  | [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. | [optional] 
 **custom_fields** | **{String: Object}** | Container for custom fields of a Rate Plan object.  | [optional] 

package/docs/OrderActionRenewSubscription.md

@@ -5,20 +5,20 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **bill_to_contact_id** | **String** | The ID of the bill-to contact associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
-**clearing_existing_bill_to_contact** | **Boolean** | Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the `billToContactId` field.  **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.  | [optional] [default to false]
-**clearing_existing_invoice_group_number** | **Boolean** | Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the `invoiceGroupNumber` field.  **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.  | [optional] [default to false]
-**clearing_existing_invoice_template** | **Boolean** | Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the `invoiceTemplateId` field.  **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.  | [optional] [default to false]
-**clearing_existing_payment_term** | **Boolean** | Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the `paymentTerm` field.  **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.  | [optional] [default to false]
-**clearing_existing_sequence_set** | **Boolean** | Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the `sequenceSetId` field.  **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.  | [optional] [default to false]
-**clearing_existing_sold_to_contact** | **Boolean** | Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the `soldToContactId` field.  **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.  | [optional] [default to false]
+**clearing_existing_bill_to_contact** | **Boolean** | Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the `billToContactId` field.   **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. | [optional] [default to false]
+**clearing_existing_invoice_group_number** | **Boolean** | Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the `invoiceGroupNumber` field.   **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. | [optional] [default to false]
+**clearing_existing_invoice_template** | **Boolean** | Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the `invoiceTemplateId` field.   **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. | [optional] [default to false]
+**clearing_existing_payment_term** | **Boolean** | Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the `paymentTerm` field.   **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. | [optional] [default to false]
+**clearing_existing_sequence_set** | **Boolean** | Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the `sequenceSetId` field.   **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. | [optional] [default to false]
+**clearing_existing_sold_to_contact** | **Boolean** | Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the `soldToContactId` field.   **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. | [optional] [default to false]
 **invoice_group_number** | **String** | The number of invoice group associated with the subscription.  **Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature enabled.  | [optional] 
 **invoice_template_id** | **String** | The ID of the invoice template associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
-**payment_term** | **String** | The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body..  | [optional] 
+**payment_term** | **String** | The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.   **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.. | [optional] 
 **sequence_set_id** | **String** | The ID of the sequence set associated with the subscription.    **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
 **sold_to_contact_id** | **String** | The ID of the sold-to contact associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
 **ship_to_contact_id** | **String** | The ID of the ship-to contact associated with the subscription.  | [optional] 
-**clearing_existing_ship_to_contact** | **Boolean** | Whether to clear the existing ship-to contact ID at the subscription level. This field is mutually exclusive with the `shipToContactId` field.  | [optional] 
+**clearing_existing_ship_to_contact** | **Boolean** | Whether to clear the existing ship-to contact ID at the subscription level. This field is mutually exclusive with the `shipToContactId` field. | [optional] 
 **communication_profile_id** | **String** | The ID of the communication profile associated with the subscription.  **Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature enabled.  | [optional] 
-**clearing_existing_communication_profile** | **Boolean** | Whether to clear the existing communication profile at the subscription level. This field is mutually exclusive with the `communicationProfileId` field.  | [optional] 
+**clearing_existing_communication_profile** | **Boolean** | Whether to clear the existing communication profile at the subscription level. This field is mutually exclusive with the `communicationProfileId` field. | [optional] 
 
 

package/docs/OrderActionTermsAndConditions.md

@@ -5,9 +5,9 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **auto_renew** | **Boolean** |  | [optional] 
-**bill_to_contact_id** | **String** | The ID of the bill-to contact associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
+**bill_to_contact_id** | **String** | The ID of the bill-to contact associated with the subscription.  n**Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
 **clearing_existing_bill_to_contact** | **Boolean** | Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the `billToContactId` field.  **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.  | [optional] [default to false]
-**clearing_existing_invoice_group_number** | **Boolean** | Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the `invoiceGroupNumber` field.  **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.  | [optional] [default to false]
+**clearing_existing_invoice_group_number** | **Boolean** | Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the `invoiceGroupNumber` field.   **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. | [optional] [default to false]
 **clearing_existing_invoice_template** | **Boolean** | Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the `invoiceTemplateId` field.  **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.  | [optional] [default to false]
 **clearing_existing_payment_term** | **Boolean** | Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the `paymentTerm` field.  **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.  | [optional] [default to false]
 **clearing_existing_sequence_set** | **Boolean** | Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the `sequenceSetId` field.  **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.  | [optional] [default to false]
@@ -15,8 +15,8 @@ Name | Type | Description | Notes
 **initial_term** | [**InitialTerm**](InitialTerm.md) |  | [optional] 
 **invoice_separately** | **Boolean** | Specifies whether the subscription appears on a separate invoice when Zuora generates invoices. | [optional] 
 **invoice_group_number** | **String** | The number of invoice group associated with the subscription.  **Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature enabled.  | [optional] 
-**invoice_template_id** | **String** | The ID of the invoice template associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
-**payment_term** | **String** | The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
+**invoice_template_id** | **String** | The ID of the invoice template associated with the subscription.  n**Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
+**payment_term** | **String** | The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.  n**Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
 **renewal_setting** | [**RenewalSetting**](RenewalSetting.md) |  | [optional] 
 **renewal_terms** | [**[RenewalTerm]**](RenewalTerm.md) |  | [optional] 
 **scheduled_cancel_date** | **String** | The date when the subscription is scheduled to be canceled. The subscription is not canceled until the date specified in this field.  | [optional] 
@@ -25,12 +25,12 @@ Name | Type | Description | Notes
 **clearing_scheduled_cancel_date** | **Boolean** | Whether to clear the scheduled cancel date at the subscription level. This field is mutually exclusive with the scheduledCancelDate field.   | [optional] 
 **clearing_scheduled_suspend_date** | **Boolean** | Whether to clear the scheduled suspend date at the subscription level. This field is mutually exclusive with the scheduledSuspendDate field.   | [optional] 
 **clearing_scheduled_resume_date** | **Boolean** | Whether to clear the scheduled resume date at the subscription level. This field is mutually exclusive with the scheduledResumeDate field.   | [optional] 
-**sequence_set_id** | **String** | The ID of the sequence set associated with the subscription.    **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
-**sold_to_contact_id** | **String** | The ID of the sold-to contact associated with the subscription.  **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
+**sequence_set_id** | **String** | The ID of the sequence set associated with the subscription.   **Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
+**sold_to_contact_id** | **String** | The ID of the sold-to contact associated with the subscription.  n**Note**:    - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.    - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.  | [optional] 
 **ship_to_contact_id** | **String** | The ID of the ship-to contact associated with the subscription. | [optional] 
 **clearing_existing_ship_to_contact** | **Boolean** | Whether to clear the existing ship-to contact ID at the subscription level. This field is mutually exclusive with the `shipToContactId` field. | [optional] 
 **payment_profile** | [**PaymentProfile**](PaymentProfile.md) |  | [optional] 
 **communication_profile_id** | **String** | The ID of the communication profile associated with the subscription.  **Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature enabled.  | [optional] 
-**clearing_existing_communication_profile** | **Boolean** | Whether to clear the existing communication profile at the subscription level. This field is mutually exclusive with the `communicationProfileId` field.  | [optional] 
+**clearing_existing_communication_profile** | **Boolean** | Whether to clear the existing communication profile at the subscription level. This field is mutually exclusive with the `communicationProfileId` field. | [optional]