| auto_renew |
BOOLEAN |
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. Values: true, false |
[optional] |
| contract_effective_date |
Date |
The date when the amendment's changes become effective for billing purposes. Version notes: -- |
[optional] |
| current_term |
Integer |
The length of the period for the current subscription term. This field can be updated when Status is `Draft`. Required: Only if the value of the Type field is set to `TermsAndConditions` and TermType is set to `TERMED`. This field is not required if TermType is set to `EVERGREEN`. Character limit: Values: a valid number |
[optional] |
| current_term_period_type |
String |
The period type for the current subscription term. 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. Required: Only if the value of the Status field is set to PendingAcceptance. Version notes: -- |
[optional] |
| description |
String |
A description of the amendment. Character limit: 500 Values: maximum 500 characters |
[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. Required: For the cancellation amendments. Optional for other types of amendments. Version notes: -- |
[optional] |
| name |
String |
The name of the amendment. Character limit: 100 Values: a string of 100 characters or fewer |
[optional] |
| renewal_setting |
String |
Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed. Required: If TermType is Termed Values: RENEW_WITH_SPECIFIC_TERM (default), RENEW_TO_EVERGREEN |
[optional] |
| renewal_term |
Integer |
The term of renewal for the amended subscription. This field can be updated when Status is `Draft`. Required: Only if the value of the Type field is set to `TermsAndConditions`. Character limit: Values: a valid number |
[optional] |
| renewal_term_period_type |
String |
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. Required: Only if the value of the Status field is set to PendingActivation. Version notes: -- |
[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. Required: Only for the UpdateProduct amendments if there is already a future-dated UpdateProduct amendment on the subscription. |
[optional] |
| status |
String |
The status of the amendment. Type: string (enum) Character limit: 17 Values: one of the following: - Draft (default, if left null) - Pending Activation - Pending Acceptance - Completed |
[optional] |
| subscription_id |
String |
The ID of the subscription that the amendment changes. Character limit: 32 Values: a valid subscription ID |
[optional] |
| term_start_date |
Date |
The date when the new terms and conditions take effect. Required: Only if the value of the Type field is set to TermsAndConditions. Version notes: -- |
[optional] |
| term_type |
String |
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. Required: Only when as part of an amendment of type TermsAndConditions to change the term type of a subscription. Type: string Character limit: 9 Values: TERMED, EVERGREEN |
[optional] |
| type |
String |
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.) |
[optional] |