Customer account number or ID

The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: CreditMemo, UnappliedPayment.

Note:

• This field is valid only if the applyCredit field is set to true.
• If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments.
• If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is ["CreditMemo"], only credit memos are used to apply to invoices.

If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.

Note: This field is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.

Whether to automatically apply 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.

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.

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.

Prerequisite: The invoice or runBilling field must be true.

Note: This field is available only if you are on the latest Zuora API minor version, or you set the zuora-version request header to 196.0 or a later available version.

Effective contract date for this subscription, as yyyy-mm-dd

A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code.

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.

The date of the billing document, in yyyy-mm-dd format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.

• If this field is specified, the specified date is used as the billing document date.
• If this field is not specified, the date specified in the targetDate is used as the billing document date.

An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.

The ID of the payment gateway instance. For example, 2c92c0f86078c4d5016091674bcc3e92.

If Payment Gateway Routing is enabled:

• If this field is not specified, gateway routing rules will be invoked.
• If this field is specified, the specified gateway will be used to process the payment.

If Payment Gateway Routing is disabled:

• If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant.
• If this field is specified, the specified gateway will be used to process the payment.

The length of the period for the first subscription term. 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.

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

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.

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.

The last booking date of the subscription object. This field is writable only when the subscription is newly created as a first version subscription. You can override the date value when creating a subscription through the Subscribe and Amend API or the subscription creation UI (non-Orders). Otherwise, the default value today is set per the user's timezone. The value of this field is as follows:

• For a new subscription created by the Subscribe and Amend APIs, this field has the value of the subscription creation date.
• For a subscription changed by an amendment, this field has the value of the amendment booking date.
• For a subscription created or changed by an order, this field has the value of the order date.

String of up to 500 characters.

The ID of the payment method used for the payment.

Indicates whether the subscription will consume the reserved payment amount of the customer account. See Prepaid Cash with Drawdown for more information.

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

The length of the period for the subscription renewal term. Default is 0.

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

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. Note: This field is available only if you are on the latest Zuora API minor version, or you set the zuora-version request header to 211.0 or a later available version.

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.

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.

Container for one or more rate plans for this subscription.

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.

Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date.

Note: - This field is available only if you are on the latest Zuora API minor version, or you set the zuora-version request header to 211.0 or a later available version.

• The credit memo is only available if you have the Invoice Settlement feature enabled.

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.

Possible values are: TERMED, EVERGREEN.

The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field.

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.

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.

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.

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.

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.

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Status of the subscription's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

The NetSuite project that the subscription was created from. Only available if you have installed the Zuora Connector for NetSuite.

The NetSuite sales order than the subscription was created from. Only available if you have installed the Zuora Connector for NetSuite.

Date when the subscription was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.