| cpq_bundle_json_id__qt |
str |
The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field. |
[optional] |
| opportunity_close_date__qt |
date |
The closing date of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. |
[optional] |
| opportunity_name__qt |
str |
The unique identifier of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. |
[optional] |
| quote_business_type__qt |
str |
The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal or Churn. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. |
[optional] |
| quote_number__qt |
str |
The unique identifier of the Quote. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. |
[optional] |
| quote_type__qt |
str |
The Quote type that represents the subscription lifecycle stage such as New, Amendment, Renew or Cancel. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. |
[optional] |
| integration_id__ns |
str |
ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
[optional] |
| integration_status__ns |
str |
Status of the subscription's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
[optional] |
| project__ns |
str |
The NetSuite project that the subscription was created from. Only available if you have installed the Zuora Connector for NetSuite. |
[optional] |
| sales_order__ns |
str |
The NetSuite sales order than the subscription was created from. Only available if you have installed the Zuora Connector for NetSuite. |
[optional] |
| sync_date__ns |
str |
Date when the subscription was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
[optional] |
| account_id |
str |
This field can be updated when Status is `Draft`. The ID of a valid account ID. |
[optional] |
| auto_renew |
bool |
This field can be updated when Status is `Draft`. Indicates if the subscription automatically renews at the end of the term. Values: `true`, `false` |
[optional] |
| cancelled_date |
date |
The date of the Amendment object. Values: inherited from `Amendment.EffectiveDate` |
[optional] |
| contract_acceptance_date |
date |
The date when the customer accepts the contract. This field can be updated when Status is `Draft`. |
[optional] |
| contract_effective_date |
date |
The date when the contract takes effect. This field can be updated when Status is `Draft`. Note: This field is required in the Subscribe call. If you set the value of this field to null and both the ServiceActivationDate and ContractAcceptanceDate fields are not required, the Subscribe call still returns success, but the new subscription is in `DRAFT` status. To activate the subscription, you must set a valid date to this field. |
[optional] |
| current_term_period_type |
str |
The period type for the current subscription term. This field is used with the CurrentTerm field to specify the current subscription term. Values: - `Month` (default) - `Year` - `Day` - `Week` |
[optional] |
| initial_term |
int |
The length of the period for the first subscription term. This field can be updated when Status is `Draft`. Required: If TermType is Termed Character limit: 20 Values: any valid number. The default value is 0. |
[optional] |
| initial_term_period_type |
str |
The period type for the first subscription term. Values: - `Month` (default) - `Year` - `Day` - `Week` Note: - This field can be updated when Status is `Draft`. - This field is used with the InitialTerm field to specify the initial subscription term. |
[optional] |
| invoice_owner_id |
str |
This field can be updated when Status is `Draft`. A valid account ID. |
[optional] |
| is_invoice_separate |
bool |
Determines if the subscription is invoiced separately. If `TRUE`, then all charges for this subscription are collected into the subscription's own invoice. Values: `TRUE`, `FALSE `(default) |
[optional] |
| name |
str |
The unique identifier of the subscription. If you don't specify a value, then Zuora generates a name automatically. Whether auto-generated or manually specified, the subscription name must be unique. Otherwise an error will occur. Character limit: 100 Values: one of the following: - leave null to automatically generate - a string of 100 characters or fewer |
[optional] |
| notes |
str |
Use this field to record comments about the subscription. Character limit: 500 Values: a string of 500 characters or fewer |
[optional] |
| renewal_setting |
str |
This field can be updated when Status is `Draft`. Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed. Required: If TermType is Termed Values: `RENEW_WITH_SPECIFIC_TERM `(default), `RENEW_TO_EVERGREEN` |
[optional] |
| renewal_term |
int |
The length of the period for the subscription renewal term. This field can be updated when Status is `Draft`. Required: If TermType is Termed. Character limit: 20 Values: one of the following: - leave null to default to `0` - any number |
[optional] |
| renewal_term_period_type |
str |
The period type for the subscription renewal term. Values: - `Month` (default) - `Year` - `Day` - `Week` Note: - This field is used with the RenewalTerm field to specify the subscription renewal term. - This field can be updated when Status is `Draft`. |
[optional] |
| service_activation_date |
date |
The date when the subscription is activated. This field can be updated when Status is `Draft`. Character limit: 29 |
[optional] |
| status |
str |
The status of the subscription. Character limit: 17 Values: automatically generated Possible values: one of the following: - `Draft` - `PendingActivation` - `PendingAcceptance` - `Active` - `Cancelled` - `Expired` - `Suspended` (This value is in Limited Availability.) |
[optional] |
| term_start_date |
date |
This field can be updated when Status is `Draft`. The date when the subscription term begins. If this is a renewal subscription, then this date is different from the subscription start date. Character limit: 29 Version notes: -- |
[optional] |
| term_type |
str |
This field can be updated when Status is `Draft`. Indicates if a subscription is termed or evergreen. Character limit: 9 Values: `TERMED`, `EVERGREEN` |
[optional] |
| version |
int |
The version number of the subscription. Values: automatically generated |
[optional] |