Suspend methods. Specify a way to suspend a subscription.

Value:

• Today: The subscription suspension takes effect on today's date.
• EndOfLastInvoicePeriod: The subscription suspension takes effect at the end of the last invoice period. The suspend date defaults to a date that is one day after the last invoiced period. You can choose this option to avoid any negative invoices (credits) issued back to the customer after the subscription suspension.
• SpecificDate: The subscription suspension takes effect on a specific date. You must define the specific date in the suspendSpecificDate field.
• FixedPeriodsFromToday: The subscription suspension takes effect after a specified period based on today's date. You must specify the suspendPeriods and suspendPeriodsType fields to define the period.

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.

The booking date that you want to set for the amendment contract when you suspend the subscription. If resume is true, which means you also choose to resume the subscription at some point, then this field is also the booking date for the Resume amendment contract.

This field must be in the yyyy-mm-dd format. The default value of this field is the current date when you make the API call.

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 only available if you set the zuora-version request header to 196.0 or later available versions.

The date when the customer notifies you that they want to amend their subscription.

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 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.

Whether to extend the subscription term by the length of time the suspension is in effect. Values: true, false.

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 false.

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.

Note: This field has been replaced by the invoice field and the collect field. invoiceCollect is available only for backward compatibility.

Note: This field is only available if you set the zuora-version request header to 186.0, 187.0, 188.0, or 189.0.

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 available versions.

The date when the order is signed. If no additinal contractEffectiveDate is provided, this order will use this order date as the contract effective date. This field must be in the yyyy-mm-dd format. This field is required for Orders customers only, not applicable to Orders Harmonization customers.

Whether to set when to resume a subscription when creating a suspend amendment. Values: true, false.

The length of the period used to specify when the subscription is resumed. The subscription resumption takes effect after a specified period based on the suspend date or today's date. You must use this field together with the resumePeriodsType field to specify the period.

Note: This field is only applicable when the suspendPolicy field is set to FixedPeriodsFromToday or FixedPeriodsFromSuspendDate.

The period type used to define when the subscription resumption takes effect. The subscription resumption takes effect after a specified period based on the suspend date or today's date. You must use this field together with the resumePeriods field to specify the period.

Values: Day, Week, Month, Year

Note: This field is only applicable when the suspendPolicy field is set to FixedPeriodsFromToday or FixedPeriodsFromSuspendDate.

Resume methods. Specify a way to resume a subscription. Values:

• Today: The subscription resumption takes effect on today's date.

• FixedPeriodsFromSuspendDate: The subscription resumption takes effect after a specified period based on the suspend date. You must specify the resumePeriods and resumePeriodsType fields to define the period.

• SpecificDate: The subscription resumption takes effect on a specific date. You must define the specific date in the resumeSpecificDate field.

• FixedPeriodsFromToday: The subscription resumption takes effect after a specified period based on the today's date. You must specify the resumePeriods and resumePeriodsType fields to define the period.

• suspendDate: The subscription resumption takes effect on the date of suspension of the subscription.

A specific date when the subscription resumption takes effect, in the format yyyy-mm-dd.

Note: This field is only applicable only when the resumePolicy field is set to SpecificDate.

The value should not be earlier than the subscription suspension date.

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 available versions. To use this field in the method, you must set the zuora-version parameter to the minor version number in the request header.

The length of the period used to specify when the subscription suspension takes effect. The subscription suspension takes effect after a specified period based on today's date. You must use this field together with the suspendPeriodsType field to specify the period.

Note: This field is only applicable only when the suspendPolicy field is set to FixedPeriodsFromToday.

The period type used to define when the subscription suspension takes effect. The subscription suspension takes effect after a specified period based on today's date. You must use this field together with the suspendPeriods field to specify the period.

Type: string (enum)

Values: Day, Week, Month, Year

Note: This field is only applicable only when the suspendPolicy field is set to FixedPeriodsFromToday.

A specific date when the subscription suspension takes effect, in the format yyyy-mm-dd.

Note: This field is only applicable only when the suspendPolicy field is set to SpecificDate.

The value should not be earlier than the subscription contract effective date, later than the subscription term end date, or within a period for which the customer has been invoiced.