Welcome to Zuora Product Documentation

Explore our rich library of product information

AmendOptions

Use this reference to learn the AmendOptions container and its fields.

Use the AmendOptions container to specify billing options, such as invoice generation and when to process payments.

AmendmentOptions fields

Name

Required?

Description

ApplyCreditBalance

optional

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.

Type : boolean

Version notes : WSDL 54.0+

Values : true , false

GenerateInvoice

optional

Determines whether to generate an invoice to immediately bill the customer for a new product or changes of Terms And Conditions. As a best practice, set this value to true to prevent any errors that might occur if the account has a balance.

Type : boolean

Version notes : WSDL 28.0+

System-generated : no

Values: true (default), false

Usage Notes:

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

  • If EnablePreviewMode=true is specified in the PreviewOptions container, then preview mode will be enabled and an invoice will not be generated, regardless of whether GenerateInvoice is specified as true or false.

InvoiceProcessingOptions

optional

Contains an attribute for generating invoices. This field doesn't take any values itself.

Type : container

Version notes : WSDL 28.0+

System- generated l: no

Values : no values -- use it to nest an attribute

ProcessPayments

optional

Determines whether to collect payment against the invoice generated by the amend() call.

Type : boolean

Version notes : WSDL 28.0+

System-generated : no

Values : true , false

Usage Notes:

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.