Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

GetAgreementTerms

Obtains details about the terms in an agreement that you participated in as proposer or acceptor.

The details include:

TermType – The type of term, such as LegalTerm, RenewalTerm, or ConfigurableUpfrontPricingTerm.
TermID – The ID of the particular term, which is common between offer and agreement.
TermPayload – The key information contained in the term, such as the EULA for LegalTerm or pricing and dimensions for various pricing terms, such as ConfigurableUpfrontPricingTerm or UsageBasedPricingTerm.

Configuration – The buyer/acceptor's selection at the time of agreement creation, such as the number of units purchased for a dimension or setting the EnableAutoRenew flag.

Request Syntax


{
   "agreementId": "string",
   "maxResults": number,
   "nextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

agreementId

The unique identifier of the agreement.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9_/-]+

Required: Yes

maxResults

The maximum number of agreements to return in the response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

nextToken

A token to specify where to start pagination.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: [a-zA-Z0-9+/=_-]+

Required: No

Response Syntax


{
   "acceptedTerms": [ 
      { ... }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

acceptedTerms

A subset of terms proposed by the proposer that have been accepted by the acceptor as part of the agreement creation.

Type: Array of AcceptedTerm objects

nextToken

The token used for pagination. The field is null if there are no more results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: [a-zA-Z0-9+/=_-]+

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

User does not have sufficient access to perform this action.

message: Description of the error.
reason: The reason for the access denied exception.
requestId: The unique identifier for the error.

HTTP Status Code: 400

InternalServerException

Unexpected error during processing of request.

message: Description of the error.
requestId: The unique identifier for the error.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

message: Description of the error.
requestId: The unique identifier for the error.
resourceId: The unique identifier for the resource.
resourceType: The type of resource.

HTTP Status Code: 400

ThrottlingException

Request was denied due to request throttling.

message: Description of the error.
requestId: The unique identifier for the error.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by the service.

fields: The fields associated with the error.
message: Description of the error.
reason: The reason associated with the error.
requestId: The unique identifier associated with the error.

HTTP Status Code: 400

Examples

Sample request

This example illustrates one usage of GetAgreementTerms.


{
   "agreementId": "fEXAMPLE-0aa6-4e42-8715-6a1EXAMPLE95"
}

Sample response

This example illustrates one usage of GetAgreementTerms.


{
    "AcceptedTerms": [{
            "ConfigurableUpfrontPricingTerm": {
                "Type": "ConfigurableUpfrontPricingTerm",
                "CurrencyCode": "USD",
                "RateCards": [{
                        "Selector": {
                            "Type": "Duration",
                            "Value": "P24M"
                        },
                        "Constraints": {
                            "MultipleDimensionSelection": "Allowed",
                            "QuantityConfiguration": "Allowed"
                        },
                        "RateCard": [{
                                "DimensionKey": "AdminUsers",
                                "Price": "0.5"
                            },
                            {
                                "DimensionKey": "ReadOnlyUsers",
                                "Price": "1"
                            }
                        ]
                    },
                    {
                        "Selector": {
                            "Type": "Duration",
                            "Value": "P36M"
                        },
                        "Constraints": {
                            "MultipleDimensionSelection": "Allowed",
                            "QuantityConfiguration": "Allowed"
                        },
                        "RateCard": [{
                                "DimensionKey": "AdminUsers",
                                "Price": "1"
                            },
                            {
                                "DimensionKey": "ReadOnlyUsers",
                                "Price": "2"
                            }
                        ]
                    }
                ],
                "Configuration": {
                    "Dimensions": [{
                        "DimensionKey": "AdminUsers",
                        "DimensionValue": 1
                    }],
                    "SelectorValue": "P24M"
                }
            }
        },
        {
            "RenewalTerm": {
                "Type": "RenewalTerm",
                "Configuration": {
                    "EnableAutoRenew": false
                }
            }
        },
        {
            "VariablePaymentTerm": {
                "Type": "VariablePaymentTerm",
                "CurrencyCode": "USD",
                "MaxTotalChargeAmount": "50",
                "Configuration": {
                    "ExpirationDuration": "P10D",
                    "PaymentRequestApprovalStrategy": "AUTO_APPROVE_ON_EXPIRATION"
                }
            }
        },
        {
            "legalTerm": {
                "type": "LegalTerm",
                "documents": [{
                    "type": "CustomEula",
                    "url": "URL"
                }]
            }
        }

    ],
    "nextToken": null
}