| 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 |
The ID of the account associated with this subscription. |
[optional] |
| account_name |
str |
The name of the account associated with this subscription. |
[optional] |
| account_number |
str |
The number of the account associated with this subscription. |
[optional] |
| auto_renew |
bool |
If `true`, the subscription automatically renews at the end of the term. Default is `false`. |
[optional] |
| contract_effective_date |
date |
Effective contract date for this subscription, as yyyy-mm-dd. |
[optional] |
| contracted_mrr |
str |
Monthly recurring revenue of the subscription. |
[optional] |
| current_term |
int |
The length of the period for the current subscription term. |
[optional] |
| current_term_period_type |
str |
The period type for the current subscription term. Values are: * `Month` (default) * `Year` * `Day` * `Week` |
[optional] |
| customer_acceptance_date |
date |
The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd. |
[optional] |
| id |
str |
Subscription ID. |
[optional] |
| initial_term |
int |
The length of the period for the first subscription term. |
[optional] |
| initial_term_period_type |
str |
The period type for the first subscription term. Values are: * `Month` (default) * `Year` * `Day` * `Week` |
[optional] |
| invoice_owner_account_id |
str |
|
[optional] |
| invoice_owner_account_name |
str |
|
[optional] |
| invoice_owner_account_number |
str |
|
[optional] |
| invoice_separately |
str |
Separates a single subscription from other subscriptions and creates an invoice for the subscription. 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. |
[optional] |
| notes |
str |
A string of up to 65,535 characters. |
[optional] |
| order_number |
str |
The order number of the order in which the changes on the subscription are made. Note: This field is only available if you have the Order Metrics feature enabled. If you wish to have access to the feature, submit a request at Zuora Global Support. We will investigate your use cases and data before enabling this feature for you. |
[optional] |
| rate_plans |
list[GETSubscriptionRatePlanType] |
Container for rate plans. |
[optional] |
| renewal_setting |
str |
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 |
int |
The length of the period for the subscription renewal term. |
[optional] |
| renewal_term_period_type |
str |
The period type for the subscription renewal term. Values are: * `Month` (default) * `Year` * `Day` * `Week` |
[optional] |
| service_activation_date |
date |
The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd |
[optional] |
| status |
str |
Subscription status; possible values are: * `Draft` * `PendingActivation` * `PendingAcceptance` * `Active` * `Cancelled` * `Suspended` (This value is in Limited Availability.) |
[optional] |
| subscription_number |
str |
Subscription number. |
[optional] |
| subscription_start_date |
date |
Date the subscription becomes effective. |
[optional] |
| success |
bool |
Returns `true` if the request was processed successfully. |
[optional] |
| term_end_date |
date |
Date the subscription term ends. If the subscription is evergreen, this is null or is the cancellation date (if one has been set). |
[optional] |
| term_start_date |
date |
Date the subscription term begins. If this is a renewal subscription, this date is different from the subscription start date. |
[optional] |
| term_type |
str |
Possible values are: `TERMED`, `EVERGREEN`. |
[optional] |
| total_contracted_value |
str |
Total contracted value of the subscription. |
[optional] |