Skip to content

Latest commit

 

History

History
20 lines (17 loc) · 7.22 KB

PUTSubscriptionResumeType.md

File metadata and controls

20 lines (17 loc) · 7.22 KB
Raw

Zuora::PUTSubscriptionResumeType

Properties

Name Type Description Notes
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]
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 false. 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` parameter to the minor version number in the request header. Prerequisite: `invoice` must be `true`. [optional]
contract_effective_date Date The date when the customer notifies you that they want to resume their subscription. [optional]
extends_term BOOLEAN Whether to extend the subscription term by the length of time the suspension is in effect. Values: `true`, `false`. [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 `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. [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`, an invoice is generated and payment collected automatically during the subscription process. If `false` (default), 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_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]
resume_periods String 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`. [optional]
resume_periods_type String 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`. [optional]
resume_policy String 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.
resume_specific_date Date 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. [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 false]
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]