Skip to content

Latest commit

 

History

History
21 lines (18 loc) · 6.4 KB

POSTSubscriptionCancellationType.md

File metadata and controls

21 lines (18 loc) · 6.4 KB
Raw

Zuora::POSTSubscriptionCancellationType

Properties

Name Type Description Notes
opportunity_close_date_qt String The closing date of the Opportunity. This field is populated when the subscription originates from Zuora Quotes. This field is used only for reporting subscription metrics. [optional]
opportunity_name_qt String The unique identifier of the Opportunity. This field is populated when the subscription originates from Zuora Quotes. This field is used only for reporting subscription metrics. [optional]
quote_business_type_qt String The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal, or Churn. This field is populated when the subscription originates from Zuora Quotes. This field is used only for reporting subscription metrics. [optional]
quote_number_qt String The unique identifier of the Quote. This field is populated when the subscription originates from Zuora Quotes. This field is used only for reporting subscription metrics. [optional]
quote_type_qt String The Quote type that represents the subscription lifecycle stage such as New, Amendment, Renew or Cancel. This field is populated when the subscription originates from Zuora Quotes. [optional]
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]
cancellation_effective_date Date Date the cancellation takes effect, in the format yyyy-mm-dd. Use only if `cancellationPolicy` is `SpecificDate`. 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. [optional]
cancellation_policy String Cancellation method. Possible values are: `EndOfCurrentTerm`, `EndOfLastInvoicePeriod`, `SpecificDate`. If using `SpecificDate`, the `cancellationEffectiveDate` field is required.
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]
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 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 automatically collected. Default is `false`. This field is in Zuora REST API version control. Supported minor versions are `186.0`, `187.0`, `188.0`, `189.0`, and `196.0`.
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]
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]