AmendOptions

Last updated
Save as PDF

The AmendOptions object is a parameter of the AmendOptions object is a parameter of the amend() call, which is used to modify subscriptions. This SOAP API reference describes this complex type including supported calls and field descriptions.

Supported Calls

amend() only

Field Descriptions

All field names are case sensitive.

Name Required? Type Description

ApplyCreditBalance

optional

boolean

Determines whether any credit balance on a customer's account is automatically applied to invoices. If no value is specified then this field defaults to false.

Version notes: WSDL 54.0+

Allowable values: true, false

ElectronicPaymentOptions

optional

complex

Represents the electronic payment method that the subscription uses to pay the invoice.

Version notes: WSDL 70+

Contains the following field:

PaymentMethodId

Specifies the ID of the electronic payment method.

The payment method must already be associated with the customer account that the subscription belongs to.

If you do not specify this field, then the default payment method of the customer account is used.

Type: zns:ID

ExternalPaymentOptions optional An object of type:
ExternalPaymentOptions Specifies whether to create or change a subscription and mark its invoice as already paid.

GenerateInvoice

optional

string

Set to true if you want Zuora to immediately generate an invoice for the subscription being amended after the amend() call.

Zuora recommends that you set this to true to prevent any errors that might occur if the account has a balance.

Note:
Even if you do not include this field in the amend() call, Zuora still parses this field with the default value, true, when processing the amend() call. If you do not want to generate the invoice after creating the New Product or Term And Condition amendment, set the value of this field to false in the request.

Possible Values: true (default), false

InvoiceProcessingOptions

optional

An object of type:
InvoiceProcessingOptions

Specifies whether, and how, an invoice should be generated for a new amendment

ProcessPayments

optional

string

Set to true if you want Zuora to collect payment against the invoice generated by the amend() call. AutoPay on the account must set to true.

When AutoPay is set to false, the payment is processed if the invoice has a balance and has a valid electronic payment method.

Note:

Even if you do not include this field in the amend() call, Zuora still parses this field with the default value, true, when processing the amend() call. If you do not want to collect payment against the generated invoice after creating the New Product or Term And Condition amendment, set the value of this field to false in the request.

Possible Values: true, false