Skip to content

Latest commit

 

History

History
38 lines (35 loc) · 9.05 KB

POSTSubscriptionType.md

File metadata and controls

38 lines (35 loc) · 9.05 KB
Raw

Zuora::POSTSubscriptionType

Properties

Name Type Description Notes
cpq_bundle_json_id__qt String [optional]
opportunity_close_date__qt String [optional]
opportunity_name__qt String [optional]
quote_business_type__qt String [optional]
quote_number__qt String [optional]
quote_type__qt String [optional]
account_key String Customer account number or ID
apply_credit_balance BOOLEAN 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 Advanced AR Settlement feature enabled. [optional]
auto_renew BOOLEAN 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 BOOLEAN 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
custom_field__c String Any custom fields defined for this object. The custom field name is case-sensitive. [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. Default value is dependent on the value of other fields. See Notes section for more details. [optional]
initial_term Integer 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 String 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 BOOLEAN 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 BOOLEAN 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 String 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 BOOLEAN 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 String String of up to 500 characters. [optional]
renewal_setting String 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 Integer The length of the period for the subscription renewal term. Default is `0`.
renewal_term_period_type String 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 BOOLEAN Creates an invoice for a subscription. If you have the Advanced AR 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 Advanced AR 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 Array<POSTSrpCreateType> Container for one or more rate plans for this subscription.
subscription_number String 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 Avdanced AR 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 String Possible values are: `TERMED`, `EVERGREEN`.