| auto_renew |
bool |
Determines whether the subscription is automatically renewed, or whether it expires at the end of the term and needs to be manually renewed. For amendment of type `TermsAndConditions`, this field is only required if you change the automatic renewal status of a subscription. Values: true, false |
[optional] |
| code |
str |
A unique alphanumeric string that identifies the amendment. Character limit: 50 Values: one of the following: - `null` generates a value automatically - A string |
[optional] |
| contract_effective_date |
date |
The date when the amendment's changes become effective for billing purposes. |
|
| created_by_id |
str |
The user ID of the person who created the amendment. Character limit: 32 Values: automatically generated |
[optional] |
| created_date |
datetime |
The date when the amendment was created. Values: automatically generated |
[optional] |
| current_term |
int |
The length of the period for the current subscription term. This field can be updated when Status is `Draft`. This field is only required if the `Type` field is set to `TermsAndConditions` and `TermType` is set to `TERMED`. This field is not required if `TermType` is set to `EVERGREEN`. Values: a valid number |
[optional] |
| current_term_period_type |
str |
The period type for the current subscription term. This field is only required if the `Type` field is set to `TermsAndConditions` and `TermType` is set to `TERMED`. This field is not required if `TermType` is set to `EVERGREEN`. Values: - `Month` (default) - `Year` - `Day` - `Week` Note: - This field can be updated when Status is `Draft`. - This field is used with the CurrentTerm field to specify the current subscription term. |
[optional] |
| customer_acceptance_date |
date |
The date when the customer accepts the amendment's changes to the subscription. Use this field if Zuora is configured to require customer acceptance in Z-Billing. This field is only required if the `Status` field is set to `PendingAcceptance`. |
[optional] |
| description |
str |
A description of the amendment. Character limit: 500 Values: maximum 500 characters |
[optional] |
| destination_account_id |
str |
The ID of the account that the subscription is being transferred to. Character limit: 32 Values: a valid account ID |
[optional] |
| destination_invoice_owner_id |
str |
The ID of the invoice that the subscription is being transferred to. Character limit: 32 Values: a valid invoice ID |
[optional] |
| effective_date |
date |
The date when the amendment's changes take effective. This field validates that the amendment's changes are within valid ranges of products and product rate plans. This field is only required if the `Type` field is set to `Cancellation`. |
[optional] |
| name |
str |
The name of the amendment. Character limit: 100 Values: a string of 100 characters or fewer |
|
| rate_plan_data |
AmendmentRatePlanData |
|
[optional] |
| renewal_setting |
str |
Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed. This field is only required if the `TermType` field is set to `Termed`. Values: RENEW_WITH_SPECIFIC_TERM (default), RENEW_TO_EVERGREEN |
[optional] |
| renewal_term |
int |
The term of renewal for the amended subscription. This field can be updated when Status is `Draft`. This field is only required if the `Type` field is set to `TermsAndConditions`. Values: a valid number |
[optional] |
| renewal_term_period_type |
str |
The period type for the subscription renewal term. This field can be updated when Status is `Draft`. Required: Only if the value of the Type field is set to `TermsAndConditions`. This field is used with the RenewalTerm field to specify the subscription renewal term. Values: - `Month` (default) - `Year` - `Day` - `Week` |
[optional] |
| service_activation_date |
date |
The date when service is activated. Use this field if Zuora is configured to require service activation in Z-Billing. This field is only required if the `Status` field is set to `PendingActivation`. |
[optional] |
| specific_update_date |
date |
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. For the UpdateProduct amendments, this field is only required if there is already a future-dated UpdateProduct amendment on the subscription. |
[optional] |
| status |
str |
The status of the amendment. Type: string (enum) Values: one of the following: - Draft (default, if left null) - Pending Activation - Pending Acceptance - Completed |
[optional] |
| subscription_id |
str |
The ID of the subscription that the amendment changes. Character limit: 32 Values: a valid subscription ID |
|
| term_start_date |
date |
The date when the new terms and conditions take effect. This field is only required if the `Type` field is set to `TermsAndConditions`. |
[optional] |
| term_type |
str |
Indicates if the subscription isTERMED or EVERGREEN. - A TERMED subscription has an expiration date, and must be manually renewed. - An EVERGREEN subscription doesn't have an expiration date, and must be manually ended. When as part of an amendment of type `TermsAndConditions`, this field is required to change the term type of a subscription. Character limit: 9 Values: TERMED, EVERGREEN |
[optional] |
| type |
str |
The type of amendment. Character limit: 18 Values: one of the following: - Cancellation - NewProduct - OwnerTransfer - RemoveProduct - Renewal - UpdateProduct - TermsAndConditions - SuspendSubscription (This value is in Limited Availability.) - ResumeSubscription (This value is in Limited Availability.) |
|
| updated_by_id |
str |
The ID of the user who last updated the amendment. Character limit: 32 Values: automatically generated |
[optional] |
| updated_date |
datetime |
The date when the amendment was last updated. Values: automatically generated |
[optional] |