Skip to content

Latest commit

 

History

History
33 lines (30 loc) · 7.57 KB

ProxyModifySubscription.md

File metadata and controls

33 lines (30 loc) · 7.57 KB
Raw

Zuora::ProxyModifySubscription

Properties

Name Type Description Notes
account_id String This field can be updated when Status is `Draft`. The ID of 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. 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]
cpq_bundle_json_id__qt String The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field. Character limit: 32 Values: N/A [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`. Required: If TermType is 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`. A valid account ID. [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. 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]
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. Required: If TermType is 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`. 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 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`. 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]
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 String 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 Integer The version number of the subscription. Values: automatically generated [optional]