Amendment
The Amendment object holds the changes that you want to make to the relevant Subscription object, including its RatePlan, RatePlanCharge, and RatePlanChargeTier.
Amendments change subscriptions. When a customer needs to make a change to a subscription, you make that change through an amendment. Common changes include the following:
-
Change the terms and conditions of a contract.
-
Add a product to, or remove of product from, a subscription.
-
Update an existing product, such as changing the quantity.
-
Renew a subscription on the autorenewal date or before.
-
Cancel a subscription, or transfer to another owner (can be also be done directly on a subscription without an amendment)
-
Suspend an active subscription. (This feature is in Limited Availability.)
-
Resume a suspended subscription. (This feature is in Limited Availability.)
Supported calls
You can use this object with the following calls:
-
amend()
-
create()
-
query()
-
update()
-
delete()Note: Invoiced amendments cannot usually be deleted. One exception to this rule is auto-renew amendments. You can delete the last auto-renew amendment even if an invoice has been generated.
Walkthroughs and use cases
Here are some common ways to use this object:
-
Add a product to the subscription - set
TypetoNewProduct -
Update information about a product's rate plan charge - set
TypetoUpdateProduct -
Remove a product or part of a product from a subscription - set
TypetoRemoveProduct -
Change the terms and conditions of the subscription - set
TypetoTermsAndConditions -
Change the owner of the subscription set
TypetoOwnerTransfer -
Renew a subscription - set
TypetoRenewal -
Cancel a subscription - set
TypetoCancellation -
Suspend a subscription (This feature is in Limited Availability.) set
TypetoSuspendSubscription -
Resume a subscription (This feature is in Limited Availability.) set
TypetoResumeSubscription