Use Amendment to make changes to a Subscription. For example, if you wish to change the terms and conditions of a subscription, you would use an Amendment. In all, you can make the following four types of changes to a subscription using Amendment:
You can update information about a product (at the rate plan charge level) that is already included in the subscription.
You can remove (delete) a product or some part of a product from the subscription. This only deletes it from the subscription you are amending. For example, you can remove a rate plan or a rate plan charge from a product that is in the subscription.
You can change the terms and conditions of the subscription.
Supported Calls
This object is used in the create and query calls.
Fields
In addition to the following fields, zObject contributes additional fields. For information on the field types, see Field Types.
Name
Required?
Type
Allowable Values
Description
ContractEffectiveDate
Yes if Status is set to Completed; No otherwise
dateTime
A valid dateTime value
The date on which the amendment becomes effective.
CustomerAcceptanceDate
Yes if Status is set to Completed; No otherwise
dateTime
A valid dateTime value
The date on which the customer will accept or accepted the amendment.
Description
No
string
255 characters
A description of the amendment.
EffectiveDate
Yes
dateTime
A valid dateTime value
The date on which the changes being made by this amendment become effective.
InitialTerm
Yes
long
Any valid number
The initial term of service for this amendment.
Name
No
string
50 characters
A name for the amendment.
RenewalTerm
Yes
long
Any valid number
The term of renewal for the amended subscription.
ServiceActivationDate
Yes if Status is set to PendingAcceptance; No otherwise
The status of the amendment. Draft is for when it is going to be pending for a while. Draft is also used temporarily in the code while making changes before making the amendment active. Active is for when it is going to be put into effect immediately. An amendment can be deleted at any point before it becomes active.
SubscriptionId
Yes
zns: ID
A valid subscription ID
The identification number for the subscription that is being amended.
TermCommitment
Yes if Type is set to TermsAndConditions; No otherwise
string
50 characters
Used only when making changes to the terms and conditions. This is the new commitment that is being instated.
TermStartDate
Yes if Type is set to TermsAndConditions; No otherwise
date
A valid date value
Used only when making changes to the terms and conditions. This is the start date for the new terms that are being instated.
Because Amendment is a compact way of making changes to a subscription, you will not necessarily need to use all the fields provided, and when making changes, you will use different values for specific fields to indicate the type of amendment you are making.