Skip to navigation

Request: AmendRequest

View as Markdown

Use this reference to learn the AmendRequest objects and containers.

Pass an AmendRequest wrapper with the amend() call. AmendRequest is a wrapper that includes an object and containers.

AmendRequest objects and containers

NameRequired?Description
Amendment (object)requiredMake changes on a subscription.
AmendOptions (container)requiredSpecify billing options.
PreviewOptions (container)optionalPreview an amendment before committing its changes to a subscription.
ExternalPaymentOptions (container)optionalCreate or change a subscription and mark its invoice as already paid.

Containers

Containers go inside an AmendRequest wrapper.

See the following pages for container details: