Field descriptions
This reference provides the description of the fields of the Amendment object.
All field names are case sensitive. Check enumerated values in descriptions to confirm capitalization and spacing.
|
Name |
Required to Create? |
Allowed Operations |
Description |
|---|---|---|---|
|
AutoRenew |
conditional |
Create Query Update* Delete Filter |
Determines whether the subscription is automatically renewed, or whether it expires at the end of the term and needs to be manually renewed. Required: For amendment of type TermsAndConditions when changing the automatic renewal status of a subscription. Type : boolean Version notes : -- Values : true, false |
|
BookingDate |
optional |
Create Query Filter |
The date when the amendment is signed. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue. Type : date Version notes : 118.0 |
|
Code |
required |
Query Filter |
A unique alphanumeric string that identifies the amendment. Type : string Character limit : 50 Version notes : -- Values : automatically generated |
|
ContractEffectiveDate |
required |
Create Query Update Delete Filter |
The date when the amendment's changes become effective for billing purposes. Type :
Version notes : -- |
|
CreatedById |
optional |
Query Filter |
The user ID of the person who created the amendment. Type : zns:ID Character limit : 32 Version notes : WSDL 20.0+ Values : automatically generated |
|
CreatedDate |
optional |
Query Filter |
The date when the amendment was created. Type : dateTime Version notes : WSDL 20.0+ Values : automatically generated |
|
CurrentTerm |
conditional |
Create Query Update* Amend Delete Filter |
The length of the period for the current subscription term. This field can be updated when Status is Required : Only if the value of the Type field is set to Type : long Character limit : Version notes : WSDL 73.0+ Values : a valid number Note : The InitialTerm field is deprecated from WSDL 73.0, use the CurrentTerm field instead. |
|
CurrentTermPeriodType |
conditional |
Create Query Update* Amend Delete Filter |
The period type for the current subscription term. Type : string Character limit : Version notes : WSDL 73.0+ Values :
Note :
|
|
CustomerAcceptanceDate |
conditional |
Create Query Update Delete Filter |
The date when the customer accepts the amendment's changes to the subscription. This field is only required if Zuora is configured to require customer acceptance in Zuora Billing and the subscription is currently in the Pending Acceptance status (the value of the Status field is currently PendingAcceptance). Use this field together with the Status field. When you set a date in this field as a customer acceptance date, you should also set the Status field as Type :
Version notes : -- |
|
Description |
optional |
Create Query Update* Delete Filter |
A description of the amendment. Type: string Character limit : 500 Version notes : -- Values : maximum 500 characters |
|
DestinationAccountId |
optional |
Create Filter |
The ID of the subscription owner that the subscription is being transferred to. Type : zns:ID Character limit : 32 Version notes : WSDL 33.0+ requires either the DestinationAccountId field or the DestinationInvoiceOwnerId field for owner transfer amendments Values : a valid account ID |
|
DestinationInvoiceOwnerId |
optional |
Create Filter |
The ID of the invoice owner that the subscription is being transferred to. Type : zns:ID Character limit : 32 Version notes : WSDL 33.0+ requires either the DestinationAccountId field or the DestinationInvoiceOwnerId field for owner transfer amendments Values : a valid invoice ID |
|
EffectiveDate |
conditional |
Create Query Update Delete Filter |
The date when the cancellation amendment takes effect. Type :
Version notes : -- |
|
Id |
optional |
Query Filter |
The ID of this object. Upon creation of this object, this field becomes AmendmentId. Type : zns:ID Character limit : 32 Version notes : -- Values : automatically generated |
|
Name |
required |
Create Query Update* Delete Filter |
The name of the amendment. Type : string Character limit : 100 Version notes : -- Values : a string of 100 characters or fewer |
|
RatePlanData |
conditional |
Create |
A container for one RatePlan object. Required : Only for NewProduct, RemoveProduct and UpdateProduct amendments. Type : zns:RatePlanData Character limit : Version notes : -- Values : RatePlanData |
|
RenewalSetting |
conditional |
Subscribe Amend Update* Filter |
Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed. Required : If TermType is Termed Type : string Character limit : Version notes : WSDL 62+ Values : RENEW_WITH_SPECIFIC_TERM (default), RENEW_TO_EVERGREEN |
|
RenewalTerm |
conditional |
Create Query Update* Delete Filter |
The term of renewal for the amended subscription. This field can be updated when Status is Required : Only if the value of the Type field is set to Type : long Character limit : Version notes : -- Values: a valid number |
|
RenewalTermPeriodType |
optional |
Create Query Update* Amend Subscribe Delete Filter |
The period type for the subscription renewal term. This field can be updated when Status is Required : Only if the value of the Type field is set to Type : string Character limit : Version notes : WSDL 73.0+ Values :
|
|
ResumeDate |
conditional |
Amend Query Update Filter |
The date when the subscription resumption takes effect. See Resume Date for more information. Note:
This feature is in the Early Adopter phase. Required : This field is only applicable if you resume a suspended subscription. Type : date Version notes : WSDL 76.0+ |
|
ServiceActivationDate |
conditional |
Create Query Update Delete Filter |
The date when service is activated. This field is only required if Zuora is configured to require service activation in Zuora Billing and the subscription is currently in the Pending Activation status (the value of the Status field is currently Use this field together with the Status field. When you set a date in this field as a service activation date, you should also set the Status field as the expected next phase status: Type :
Version notes : -- |
|
SpecificUpdateDate |
conditional |
Amend Create Query Update |
The date when the UpdateProduct amendment takes effect. This field is only applicable if there is already a future-dated UpdateProduct amendment on the subscription. See Create an UpdateProduct Amendment Before a Future-dated Update for more information. Req uired : Only for the UpdateProduct amendments if there is already a future-dated UpdateProduct amendment on the subscription. Type : date Version notes : WSDL 71.0+ |
|
Status |
required |
Create Query Delete Filter |
The status of the amendment. Type: string (enum) Character limit : 17 Version notes : -- Values : one of the following:
|
|
SubscriptionId |
required |
Create Query Update* Delete Filter |
The ID of the subscription that the amendment changes. Type : zns:ID Character limit : 32 Version notes : -- Values : a valid subscription ID |
|
SuspendDate |
conditional |
Amend Query Update Filter |
The date when the subscription suspension takes effect. See Suspend Date for more information. Note:
This feature is in the Early Adopter phase. Required : This field is only applicable if you suspend an active subscription. Type : date Version notes : WSDL 76.0+ |
|
TermStartDate |
conditional |
Create Query Update Delete Filter |
The date when the new terms and conditions take effect. Required : Only if the value of the Type field is set to TermsAndConditions. Type :
Version notes : -- |
|
TermType |
conditional |
Create Query Update* Delete Filter |
Indicates if the subscription isTERMED or EVERGREEN.
Required : Only when as part of an amendment of type TermsAndConditions to change the term type of a subscription. Type: string Character limit : 9 Version notes : -- Values : TERMED, EVERGREEN |
|
Type |
required |
Create Query Update* Delete Filter |
The type of amendment. Type : string (enum) Character limit : 20 Version note s: The SuspendSubscription and ResumeSubscription values are available in WSDL 76.0+. Values : one of the following:
|
|
UpdatedById |
optional |
Query Filter |
The ID of the user who last updated the amendment. Type : zns:ID Character limit : 32 Version notes : WSDL 20.0+ Values : automatically generated |
|
UpdatedDate |
optional |
Query Filter |
The date when the amendment was last updated. Type : dateTime Version notes : WSDL 20.0+ Values : automatically generated |