| cpq_bundle_json_id__qt |
String |
|
[optional] |
| opportunity_close_date__qt |
String |
The closing date of the Opportunity. This field is populated when the subscription originates from Zuora Quotes. This field is used only for reporting subscription metrics. |
[optional] |
| opportunity_name__qt |
String |
The unique identifier of the Opportunity. This field is populated when the subscription originates from Zuora Quotes. This field is used only for reporting subscription metrics. |
[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 populated when the subscription originates from Zuora Quotes. This field is used only for reporting subscription metrics. |
[optional] |
| quote_number__qt |
String |
The unique identifier of the Quote. This field is populated when the subscription originates from Zuora Quotes. This field is used only for reporting subscription metrics. |
[optional] |
| quote_type__qt |
String |
The Quote type that represents the subscription lifecycle stage such as `New`, `Amendment`, `Renew`, or `Cancel`. This field is populated when the subscription originates from Zuora Quotes. This field is used only for reporting subscription metrics. |
[optional] |
| add |
Array<PUTSrpAddType> |
Container for adding one or more rate plans. |
[optional] |
| apply_credit_balance |
BOOLEAN |
Applies 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 Advanced AR Settlement feature enabled. |
[optional] |
| auto_renew |
BOOLEAN |
If `true`, this subscription automatically renews at the end of the subscription term. Default is `false`. |
[optional] |
| 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. The default value is false. Prerequisite: `invoice` must be `true`. Note: This field is in Zuora REST API version control. Supported minor versions are 196.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] |
| current_term |
Integer |
The length of the period for the current subscription term. If `termType` is `TERMED`, this field is required and must be greater than `0`. If `termType` is `EVERGREEN`, this value is ignored. Default is `0`. |
[optional] |
| current_term_period_type |
String |
The period type for the current subscription term. This field is used with the `CurrentTerm` field to specify the current subscription term. Values are: * `Month` (default) * `Year` * `Day` * `Week` |
[optional] |
| custom_field__c |
String |
Any custom fields defined for this object. The custom field name is case-sensitive. |
[optional] |
| include_existing_draft_doc_items |
BOOLEAN |
Specifies whether to include draft invoice items in subscription previews. Values are: * `true` (default). Includes draft invoice items in the preview result. * `false`. Excludes draft invoice items in the preview result. Note: This field is in Zuora REST API version control. Supported minor versions are 207.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. See Zuora REST API Versions for more information. |
[optional] |
| include_existing_draft_invoice_items |
BOOLEAN |
Specifies whether to include draft invoice items in subscription previews. Values are: * `true` (default). Includes draft invoice items in the preview result. * `false`. Excludes draft invoice items in the preview result. Note: This field is in Zuora REST API version control. Supported minor versions are 186.0, 187.0, 188.0, 189.0, and 196.0. See Zuora REST API Versions for more information. |
[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 `false`. 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 `true`, an invoice is generated and payment collected automatically during the subscription process. If `false` (default), no invoicing or payment takes place. The invoice generated in this operation is only for this subscription, not for the entire customer account. This field is in Zuora REST API version control. Supported minor versions are 186.0, 187.0, 188.0, 189.0, and 196.0. |
[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 |
Date |
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] |
| notes |
String |
String of up to 500 characters. |
[optional] |
| preview |
BOOLEAN |
If `true` the update is made in preview mode. The default setting is `false`. |
[optional] |
| preview_type |
String |
The type of preview you will receive. This field is in Zuora REST API version control. The supported values of this field depend on the REST API minor version you specified in the request header. * If you do not specify the REST API minor version or specify the minor version number to one of following values in the request header: * 186.0 * 187.0 * 188.0 * 189.0 * 196.0 The following values are supported in the previewType field: * InvoiceItem * ChargeMetrics * InvoiceItemChargeMetrics The default value is InvoiceItem. * If you specify the REST API minor version to 207.0 or later in the request header, the following values are supported in the previewType field: - LegalDoc - ChargeMetrics - LegalDocChargeMetrics The default value is LegalDoc. See Zuora REST API Versions for more information. |
[optional] |
| remove |
Array<PUTSrpRemoveType> |
Container for removing one or more rate plans. |
[optional] |
| renewal_setting |
String |
Specifies whether a termed subscription will remain `TERMED` or change to `EVERGREEN` when it is renewed. Values are: * `RENEW_WITH_SPECIFIC_TERM` (default) * `RENEW_TO_EVERGREEN` |
[optional] |
| renewal_term |
Integer |
The length of the period for the subscription renewal term. Default is `0`. |
[optional] |
| 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 Advanced AR Settlement feature enabled, a credit memo might also be created based on the invoice and credit memo generation rule. 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 Advanced AR 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] [default to false] |
| target_date |
Date |
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 Avdanced AR 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 |
Date |
Date 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`. |
[optional] |
| update |
Array<PUTSrpUpdateType> |
Container for updating one or more rate plans. |
[optional] |