amend()
Use the amend() call to change a subscription, such as upgrading the subscription.
Usage
-
Supported objects: Amendment
-
Version availability: WSDL 28.0+
-
Asynchronous process: no
Limits
Objects per call - The number of amendments supported in a single amend call are:
-
For WSDL versions 69+: Up to 10 amendments
-
For WSDL versions 42.0 through 68: Up to 3 amendments
-
For WSDL versions 29.0 through 41.0: Only 1 amendment
Errors
If one of your Amendment objects fails in a single amend() call, then the entire call fails.
Fields
The following fields are always required for this call:
Amendment.Type
-
Amendment.Name -
Amendment.SubscriptionId
Syntax and Arguments
The amend() call uses the following items:
-
Call wrappers
-
AmendRequest -
AmendResult
-
-
Containers
-
AmendOptions -
PreviewOptions -
ExternalPaymentOptions
-
-
Object
-
Amendment
-
Call wrappers
Every amend() request requires an AmendRequest wrapper. Every amend() call responds with an AmendResult wrapper.