| account_id |
String |
This field can be updated when `Status` is `Draft`. |
[optional] |
| ancestor_account_id |
String |
A filter option for querying all subscriptions under the same account hierarchy. Character limit: 32 Values: a valid account ID |
[optional] |
| auto_renew |
BOOLEAN |
This field can be updated when `Status` is `Draft`. Indicates if the subscription automatically renews at the end of the term. This field is only required if the `TermType` field is set to `TERMED`. Values: `true`, `false` |
[optional] |
| cancelled_date |
Date |
The date of the amendment that canceled the subscription. 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`. This field is only required if the Require Service Activation of Orders? Setting is set to `Yes`. If this setting is set to `Yes`: - If ContractAcceptanceDate field is required, you must set this field, ContractAcceptanceDate, and ContractEffectiveDate fields in the subscribe call to activate a subscription. - If ContractAcceptanceDate field is not required, you must set both this field and the ContractEffectiveDate field in the subscribe call to activate a subscription. If you only set a valid date in the ContractEffectiveDate field, the subscribe call still returns success, but the subscription is in `DRAT` status. |
[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. |
|
| created_by_id |
String |
The user ID of the person who created the subscription. Character limit: 32 Values: automatically generated |
[optional] |
| created_date |
DateTime |
The date the subscription was created. This value is the same as the OriginalCreatedDate value until the subscription is amended. Values: automatically generated |
[optional] |
| creator_account_id |
String |
The account ID that created the subscription or the amended subscription. Character limit: 32 Values: automatically generated |
[optional] |
| creator_invoice_owner_id |
String |
The account ID that owns the invoices associated with the subscription or the amended subscription. Character limit: 32 Values: automatically generated |
[optional] |
| current_term |
Integer |
The length of the period for the current subscription term. This field is only required If the `TermType` field is set to `TERMED` and its value must be greater than `0`. If TermType is set to `EVERGREEN`, this value is ignored. Default is `0`. Character limit: 20 Values: automatically generated |
[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: - `Month` (default) - `Year` - `Day` - `Week` |
[optional] |
| initial_term |
Integer |
The length of the period for the first subscription term. This field can be updated when Status is `Draft`. If you use the subscribe call, this field is required. This field is only required if the `TermType` field is set to `TERMED`. Character limit: 20 Values: any valid number. The default value is 0. |
[optional] |
| initial_term_period_type |
String |
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 |
String |
This field can be updated when `Status` is `Draft`. |
[optional] |
| is_invoice_separate |
BOOLEAN |
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 |
String |
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. You can change this value only when the subscription is in `Draft` status. Once the subscription is activated, you can't change this value, nor can you use this value for a different subscription. Character limit: 100 Values: one of the following: - leave null to automatically generate - a string of 100 characters or fewer |
[optional] |
| notes |
String |
Use this field to record comments about the subscription. Character limit: 500 Values: a string of 500 characters or fewer |
[optional] |
| opportunity_close_date__qt |
Date |
The closing date of the Opportunity. This field is used in Zuora Reporting Data Sources to report on Subscription metrics. If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. Character limit: Values: populated by Zuora Quotes |
[optional] |
| opportunity_name__qt |
String |
The unique identifier of the Opportunity. This field is used in the Zuora Reporting Data Sources to report on Subscription metrics. If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. Character limit: 100 Values: populated by Zuora Quotes |
[optional] |
| original_created_date |
DateTime |
The date when the subscription was originally created. This value is the same as the CreatedDate value until the subscription is amended. Values: automatically generated |
[optional] |
| original_id |
String |
The original ID of this subscription. Values: automatically generated |
[optional] |
| previous_subscription_id |
String |
The subscription ID immediately prior to the current subscription. Character limit: 32 Values: automatically generated |
[optional] |
| quote_business_type__qt |
String |
The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal or Churn. This field is used in the Zuora Reporting Data Sources to report on Subscription metrics. If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. Character limit: 32 Values: populated by Zuora Quotes |
[optional] |
| quote_number__qt |
String |
The unique identifier of the Quote. This field is used in the Zuora Reporting Data Sources to report on Subscription metrics. If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. Character limit: 32 Values: populated by Zuora Quotes |
[optional] |
| quote_type__qt |
String |
The Quote type that represents the subscription lifecycle stage such as New, Amendment, Renew or Cancel. This field is used in the Zuora Reporting Data Sources to report on Subscription metrics. If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. Character limit: 32 Values: populated by Zuora Quotes |
[optional] |
| renewal_setting |
String |
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. This field is only required if the `TermType` field is set to `TERMED`. Values: `RENEW_WITH_SPECIFIC_TERM `(default), `RENEW_TO_EVERGREEN` |
[optional] |
| renewal_term |
Integer |
The length of the period for the subscription renewal term. This field can be updated when Status is `Draft`. If you use the subscribe call, this field is required. This field is only required if the `TermType` field is set to `TERMED`. Character limit: 20 Values: one of the following: - leave null to default to `0` - any number |
[optional] |
| renewal_term_period_type |
String |
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`. This field is only required if the Require Service Activation of Orders? Setting is set to `Yes`. If this setting is set to `Yes`: - If ContractAcceptanceDate field is required, you must set this field, ContractAcceptanceDate, and ContractEffectiveDate fields in the subscribe call to activate a subscription. - If ContractAcceptanceDate field is not required, you must set both this field and the ContractEffectiveDate field in the subscribe call to activate a subscription. If you only set a valid date in the ContractEffectiveDate field, the subscribe call still returns success, but the subscription is in `DRAT` status. Character limit: 29 |
[optional] |
| status |
String |
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] |
| subscription_end_date |
Date |
The date when the subscription term ends, where the subscription ends at midnight the day before. For example, if the SubscriptionEndDate is 12/31/2016, the subscriptions ends at midnight (00:00:00 hours) on 12/30/2016. This date is the same as the term end date or the cancelation date, as appropriate. Character limit: 29 Values: automatically generated |
[optional] |
| subscription_start_date |
Date |
The date when the subscription term starts. This date is the same as the start date of the original term, which isn't necessarily the start date of the current or new term. Character limit: 29 Values: automatically generated |
[optional] |
| term_end_date |
Date |
This field can be updated when Status is `Draft`. The date when the subscription term ends. If the subscription is evergreen, the TermEndDate value is null or is the cancelation date, as appropriate. Character limit: 29 Values: automatically generated |
[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. If you don't specify a value, then Zuora uses ContractEffectiveDate automatically. Character limit: 29 |
[optional] |
| term_type |
String |
This field can be updated when Status is `Draft`. Indicates if a subscription is termed or evergreen. A termed subscription has a specific end date and requires manual renewal. An evergreen subscription doesn't have an end date and doesn't need renewal. This field can be updated when the subscription status is Draft. Character limit: 9 Values: `TERMED`, `EVERGREEN` |
|
| updated_by_id |
String |
The ID of the user who last updated the subscription. Character limit: 32 **Values: **automatically generated |
[optional] |
| updated_date |
DateTime |
The date when the subscription was last updated. Character limit: 29 Values: automatically generated |
[optional] |
| version |
Integer |
The version number of the subscription. Values: automatically generated |
[optional] |