# CancelAgreementPaymentRequest
<a name="API_marketplace-agreements_CancelAgreementPaymentRequest"></a>

Allows sellers (proposers) to cancel a payment request that is in `PENDING_APPROVAL` status. Once cancelled, the payment request transitions to `CANCELLED` status and can no longer be accepted or rejected by the buyer.

**Note**  
Only payment requests in `PENDING_APPROVAL` status can be cancelled. A `ConflictException` is thrown if the payment request is in any other status.

## Request Syntax
<a name="API_marketplace-agreements_CancelAgreementPaymentRequest_RequestSyntax"></a>

```
{
   "agreementId": "string",
   "paymentRequestId": "string"
}
```

## Request Parameters
<a name="API_marketplace-agreements_CancelAgreementPaymentRequest_RequestParameters"></a>

The request accepts the following data in JSON format.

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

 ** [agreementId](#API_marketplace-agreements_CancelAgreementPaymentRequest_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_CancelAgreementPaymentRequest-request-agreementId"></a>
The unique identifier of the agreement associated with the payment request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9_/-]+`   
Required: Yes

 ** [paymentRequestId](#API_marketplace-agreements_CancelAgreementPaymentRequest_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_CancelAgreementPaymentRequest-request-paymentRequestId"></a>
The unique identifier of the payment request to cancel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `pr-[a-zA-Z0-9]+`   
Required: Yes

## Response Syntax
<a name="API_marketplace-agreements_CancelAgreementPaymentRequest_ResponseSyntax"></a>

```
{
   "agreementId": "string",
   "chargeAmount": "string",
   "createdAt": number,
   "currencyCode": "string",
   "description": "string",
   "name": "string",
   "paymentRequestId": "string",
   "status": "string",
   "updatedAt": number
}
```

## Response Elements
<a name="API_marketplace-agreements_CancelAgreementPaymentRequest_ResponseElements"></a>

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

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

 ** [agreementId](#API_marketplace-agreements_CancelAgreementPaymentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_CancelAgreementPaymentRequest-response-agreementId"></a>
The unique identifier of the agreement associated with this payment request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9_/-]+` 

 ** [chargeAmount](#API_marketplace-agreements_CancelAgreementPaymentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_CancelAgreementPaymentRequest-response-chargeAmount"></a>
The amount that was requested to be charged.  
Type: String  
Pattern: `[0-9]*(\.[0-9]{0,8})?` 

 ** [createdAt](#API_marketplace-agreements_CancelAgreementPaymentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_CancelAgreementPaymentRequest-response-createdAt"></a>
The date and time when the payment request was originally created, in ISO 8601 format.  
Type: Timestamp

 ** [currencyCode](#API_marketplace-agreements_CancelAgreementPaymentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_CancelAgreementPaymentRequest-response-currencyCode"></a>
The currency code for the charge amount.  
Type: String  
Length Constraints: Fixed length of 3.  
Pattern: `[A-Z]+` 

 ** [description](#API_marketplace-agreements_CancelAgreementPaymentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_CancelAgreementPaymentRequest-response-description"></a>
The detailed description of the payment request, if provided.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Pattern: `.+` 

 ** [name](#API_marketplace-agreements_CancelAgreementPaymentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_CancelAgreementPaymentRequest-response-name"></a>
The descriptive name of the payment request.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 64.  
Pattern: `.+` 

 ** [paymentRequestId](#API_marketplace-agreements_CancelAgreementPaymentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_CancelAgreementPaymentRequest-response-paymentRequestId"></a>
The unique identifier of the cancelled payment request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `pr-[a-zA-Z0-9]+` 

 ** [status](#API_marketplace-agreements_CancelAgreementPaymentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_CancelAgreementPaymentRequest-response-status"></a>
The updated status of the payment request, which is `CANCELLED`.  
Type: String  
Valid Values: `VALIDATING | VALIDATION_FAILED | PENDING_APPROVAL | APPROVED | REJECTED | CANCELLED` 

 ** [updatedAt](#API_marketplace-agreements_CancelAgreementPaymentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_CancelAgreementPaymentRequest-response-updatedAt"></a>
The date and time when the payment request was cancelled, in ISO 8601 format.  
Type: Timestamp

## Errors
<a name="API_marketplace-agreements_CancelAgreementPaymentRequest_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
User does not have sufficient access to perform this action.    
 ** requestId **   
The unique identifier for the error.
HTTP Status Code: 400

 ** ConflictException **   
The request could not be completed due to a conflict with the current state of the resource.    
 ** requestId **   
The unique identifier for the error.  
 ** resourceId **   
The unique identifier for the resource.  
 ** resourceType **   
The type of resource.
HTTP Status Code: 400

 ** InternalServerException **   
Unexpected error during processing of request.    
 ** requestId **   
The unique identifier for the error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource which does not exist.    
 ** 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.    
 ** 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.  
 ** reason **   
The reason associated with the error.  
 ** requestId **   
The unique identifier associated with the error.
HTTP Status Code: 400

## Examples
<a name="API_marketplace-agreements_CancelAgreementPaymentRequest_Examples"></a>

### Sample request
<a name="API_marketplace-agreements_CancelAgreementPaymentRequest_Example_1"></a>

This example illustrates one usage of CancelAgreementPaymentRequest.

```
{
    "paymentRequestId": "prEXAMPLE-1bb7-5f53-9826-7b2EXAMPLE06",
    "agreementId": "fEXAMPLE-0aa6-4e42-8715-6a1EXAMPLE95"
}
```

### Sample response
<a name="API_marketplace-agreements_CancelAgreementPaymentRequest_Example_2"></a>

This example illustrates one usage of CancelAgreementPaymentRequest.

```
{
    "paymentRequestId": "prEXAMPLE-1bb7-5f53-9826-7b2EXAMPLE06",
    "agreementId": "fEXAMPLE-0aa6-4e42-8715-6a1EXAMPLE95",
    "status": "CANCELLED",
    "name": "Q1 2024 Usage Charges",
    "description": "Payment request for Q1 2024 usage charges for premium support services",
    "chargeAmount": "1250.50",
    "currencyCode": "USD",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-16T09:15:00.000Z"
}
```

## See Also
<a name="API_marketplace-agreements_CancelAgreementPaymentRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/marketplace-agreement-2020-03-01/CancelAgreementPaymentRequest) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/marketplace-agreement-2020-03-01/CancelAgreementPaymentRequest) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/marketplace-agreement-2020-03-01/CancelAgreementPaymentRequest) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/marketplace-agreement-2020-03-01/CancelAgreementPaymentRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/CancelAgreementPaymentRequest) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/marketplace-agreement-2020-03-01/CancelAgreementPaymentRequest) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/marketplace-agreement-2020-03-01/CancelAgreementPaymentRequest) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/marketplace-agreement-2020-03-01/CancelAgreementPaymentRequest) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/CancelAgreementPaymentRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/marketplace-agreement-2020-03-01/CancelAgreementPaymentRequest)