POSTSubscriptionType.md

POSTSubscriptionType

Properties

Name	Type	Description	Notes
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_key	str	Customer account number or ID
apply_credit_balance	bool	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 Invoice Settlement feature enabled.	[optional]
auto_renew	bool	If true, this subscription automatically renews at the end of the subscription term. This field is only required if the `termType` field is set to `TERMED`.	[optional] [default to False]
collect	bool	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 `true`. Prerequisite: The invoice field 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` field to the minor version number in the request header.	[optional]
contract_effective_date	date	Effective contract date for this subscription, as yyyy-mm-dd
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. Default value is dependent on the value of other fields. See Notes section for more details.	[optional]
initial_term	int	The length of the period for the first subscription term. Default is `0`. If `termType` is `TERMED`, then this field is required, and the value must be greater than `0`. If `termType` is `EVERGREEN`, this field is ignored.	[optional]
initial_term_period_type	str	The period type for the first subscription term. This field is used with the `InitialTerm` field to specify the initial subscription term. Values are: * `Month` (default) * `Year` * `Day` * `Week`	[optional]
invoice	bool	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 `true`. 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	bool	Note: This field has been replaced by the invoice field and the collect field. invoiceCollect is available only for backward compatibility. If `true` (default), an invoice is generated and payment collected automatically during the subscription process. If `false`, 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_owner_account_key	str	Invoice owner account number or ID. Note: This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.	[optional]
invoice_separately	bool	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	str	String of up to 500 characters.	[optional]
renewal_setting	str	Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed. Values: * `RENEW_WITH_SPECIFIC_TERM` (default) * `RENEW_TO_EVERGREEN`	[optional]
renewal_term	int	The length of the period for the subscription renewal term. Default is `0`.
renewal_term_period_type	str	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	bool	Creates an invoice for a subscription. If you have the Invoice 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 Invoice 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 True]
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. Default value is dependent on the value of other fields. See Notes section for more details.	[optional]
subscribe_to_rate_plans	list[POSTSrpCreateType]	Container for one or more rate plans for this subscription.
subscription_number	str	Subscription Number. The value can be up to 1000 characters. If you do not specify a subscription number when creating a subscription, Zuora will generate a subscription number automatically. If the account is created successfully, the subscription number is returned in the `subscriptionNumber` response field.	[optional]
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 Invoice 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	The date on which 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	str	Possible values are: `TERMED`, `EVERGREEN`.

[Back to Model list] [Back to API list] [Back to README]