AcceptAgreementCancellationRequest
Allows buyers (acceptors) to accept a cancellation request that is in PENDING_APPROVAL status. Once accepted, the cancellation request transitions to APPROVED status and the agreement cancellation will be processed.
Note
Only cancellation requests in PENDING_APPROVAL status can be accepted. A ConflictException is thrown if the cancellation request is in any other status.
Request Syntax
{
"agreementCancellationRequestId": "string",
"agreementId": "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.
- agreementCancellationRequestId
-
The unique identifier of the cancellation request to accept.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
acr-[a-zA-Z0-9]+Required: Yes
- agreementId
-
The unique identifier of the agreement associated with the cancellation request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[A-Za-z0-9_/-]+Required: Yes
Response Syntax
{
"agreementCancellationRequestId": "string",
"agreementId": "string",
"createdAt": number,
"description": "string",
"reasonCode": "string",
"status": "string",
"updatedAt": number
}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.
- agreementCancellationRequestId
-
The unique identifier of the accepted cancellation request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
acr-[a-zA-Z0-9]+ - agreementId
-
The unique identifier of the agreement associated with this cancellation request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[A-Za-z0-9_/-]+ - createdAt
-
The date and time when the cancellation request was originally created.
Type: Timestamp
- description
-
The detailed description of the cancellation reason, if provided.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
- reasonCode
-
The original reason code provided when the cancellation request was created.
Type: String
Valid Values:
INCORRECT_TERMS_ACCEPTED | REPLACING_AGREEMENT | TEST_AGREEMENT | ALTERNATIVE_PROCUREMENT_CHANNEL | PRODUCT_DISCONTINUED | UNINTENDED_RENEWAL | BUYER_DISSATISFACTION | OTHER - status
-
The updated status of the cancellation request, which is
APPROVED.Type: String
Valid Values:
PENDING_APPROVAL | APPROVED | REJECTED | CANCELLED | VALIDATION_FAILED - updatedAt
-
The date and time when the cancellation request was accepted.
Type: Timestamp
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
- ConflictException
-
Request was denied due to a resource conflict.
- message
-
Description of the error.
- requestId
-
The unique identifier for the error.
- resourceId
-
The unique identifier of the resource involved in the conflict.
- resourceType
-
The type of the resource involved in the conflict.
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 AcceptAgreementCancellationRequest.
{ "agreementCancellationRequestId": "acr-EXAMPLE752jqvg74yo7k", "agreementId": "agmt-EXAMPLE752jqvg74yo7k" }
Sample response
This example illustrates one usage of AcceptAgreementCancellationRequest.
{ "agreementCancellationRequestId": "acr-EXAMPLE752jqvg74yo7k", "agreementId": "agmt-EXAMPLE752jqvg74yo7k", "reasonCode": "PRODUCT_DISCONTINUED", "description": "Product is being discontinued and no longer supported", "status": "APPROVED", "createdAt": 1736935800, "updatedAt": 1737022200 }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: