# AWS Marketplace Agreement API


The following actions are supported by AWS Marketplace Agreement API:
+  [BatchCreateBillingAdjustmentRequest](API_marketplace-agreements_BatchCreateBillingAdjustmentRequest.md) 
+  [CancelAgreementCancellationRequest](API_marketplace-agreements_CancelAgreementCancellationRequest.md) 
+  [CancelAgreementPaymentRequest](API_marketplace-agreements_CancelAgreementPaymentRequest.md) 
+  [DescribeAgreement](API_marketplace-agreements_DescribeAgreement.md) 
+  [GetAgreementCancellationRequest](API_marketplace-agreements_GetAgreementCancellationRequest.md) 
+  [GetAgreementPaymentRequest](API_marketplace-agreements_GetAgreementPaymentRequest.md) 
+  [GetAgreementTerms](API_marketplace-agreements_GetAgreementTerms.md) 
+  [GetBillingAdjustmentRequest](API_marketplace-agreements_GetBillingAdjustmentRequest.md) 
+  [ListAgreementCancellationRequests](API_marketplace-agreements_ListAgreementCancellationRequests.md) 
+  [ListAgreementInvoiceLineItems](API_marketplace-agreements_ListAgreementInvoiceLineItems.md) 
+  [ListAgreementPaymentRequests](API_marketplace-agreements_ListAgreementPaymentRequests.md) 
+  [ListBillingAdjustmentRequests](API_marketplace-agreements_ListBillingAdjustmentRequests.md) 
+  [SearchAgreements](API_marketplace-agreements_SearchAgreements.md) 
+  [SendAgreementCancellationRequest](API_marketplace-agreements_SendAgreementCancellationRequest.md) 
+  [SendAgreementPaymentRequest](API_marketplace-agreements_SendAgreementPaymentRequest.md) 

# BatchCreateBillingAdjustmentRequest


Allows sellers (proposers) to submit billing adjustment requests for one or more invoices within an agreement. Each entry in the batch specifies an invoice and the adjustment amount. The operation returns successfully created adjustment request IDs and any errors for entries that failed to process.

**Note**  
Each entry requires a unique `clientToken` for idempotency.

## Request Syntax


```
{
   "billingAdjustmentRequestEntries": [ 
      { 
         "adjustmentAmount": "string",
         "adjustmentReasonCode": "string",
         "agreementId": "string",
         "clientToken": "string",
         "currencyCode": "string",
         "description": "string",
         "originalInvoiceId": "string"
      }
   ]
}
```

## Request Parameters


The request accepts the following data in JSON format.

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

 ** [billingAdjustmentRequestEntries](#API_marketplace-agreements_BatchCreateBillingAdjustmentRequest_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_BatchCreateBillingAdjustmentRequest-request-billingAdjustmentRequestEntries"></a>
A list of billing adjustment request entries. Each entry specifies the invoice and adjustment details.  
Type: Array of [BatchCreateBillingAdjustmentRequestEntry](API_marketplace-agreements_BatchCreateBillingAdjustmentRequestEntry.md) objects  
Required: Yes

## Response Syntax


```
{
   "errors": [ 
      { 
         "clientToken": "string",
         "code": "string",
         "message": "string"
      }
   ],
   "items": [ 
      { 
         "billingAdjustmentRequestId": "string",
         "clientToken": "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.

 ** [errors](#API_marketplace-agreements_BatchCreateBillingAdjustmentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_BatchCreateBillingAdjustmentRequest-response-errors"></a>
A list of errors for entries that failed validation, each containing the `clientToken`, error `code`, and `message`.  
Type: Array of [BatchCreateBillingAdjustmentError](API_marketplace-agreements_BatchCreateBillingAdjustmentError.md) objects

 ** [items](#API_marketplace-agreements_BatchCreateBillingAdjustmentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_BatchCreateBillingAdjustmentRequest-response-items"></a>
A list of successfully created billing adjustment items, each containing the `billingAdjustmentRequestId` and `clientToken`.  
Type: Array of [BatchCreateBillingAdjustmentItem](API_marketplace-agreements_BatchCreateBillingAdjustmentItem.md) objects

## Errors


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

 ** 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


### Sample request


This example illustrates one usage of BatchCreateBillingAdjustmentRequest.

```
{
    "billingAdjustmentRequestEntries": [
        {
            "originalInvoiceId": "E2E20230929a108cfae",
            "agreementId": "agmt-EXAMPLESvIzsqYMyQwI3",
            "adjustmentAmount": "500.00",
            "currencyCode": "USD",
            "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "adjustmentReasonCode": "OTHER",
            "description": "Customer requested adjustment due to service outage during critical business period."
        },
        {
            "originalInvoiceId": "E2E20230929b209dfbf",
            "agreementId": "agmt-EXAMPLESvIzsqYMyQwI3",
            "adjustmentAmount": "999999.00",
            "currencyCode": "USD",
            "clientToken": "d2a5e82e-a49b-4075-8c7f-EXAMPLE22222",
            "adjustmentReasonCode": "OTHER",
            "description": "Customer requested adjustment due to service outage during critical business period."
        }
    ]
}
```

### Sample response


This example illustrates one usage of BatchCreateBillingAdjustmentRequest.

```
{
    "items": [
        {
            "billingAdjustmentRequestId": "ba-EXAMPLE1a2b3c4d5e",
            "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
        }
    ],
    "errors": [
        {
            "clientToken": "d2a5e82e-a49b-4075-8c7f-EXAMPLE22222",
            "code": "VALIDATION_EXCEPTION",
            "message": "Refund amount $999999.00 exceeds maximum refundable amount $200.00"
        }
    ]
}
```

## See Also


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/BatchCreateBillingAdjustmentRequest) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/marketplace-agreement-2020-03-01/BatchCreateBillingAdjustmentRequest) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/marketplace-agreement-2020-03-01/BatchCreateBillingAdjustmentRequest) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/marketplace-agreement-2020-03-01/BatchCreateBillingAdjustmentRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/BatchCreateBillingAdjustmentRequest) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/marketplace-agreement-2020-03-01/BatchCreateBillingAdjustmentRequest) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/marketplace-agreement-2020-03-01/BatchCreateBillingAdjustmentRequest) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/marketplace-agreement-2020-03-01/BatchCreateBillingAdjustmentRequest) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/BatchCreateBillingAdjustmentRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/marketplace-agreement-2020-03-01/BatchCreateBillingAdjustmentRequest) 

# CancelAgreementCancellationRequest


Allows sellers (proposers) to withdraw an existing agreement cancellation request that is in a pending state. Once cancelled, the cancellation request transitions to `CANCELLED` status and can no longer be approved or rejected by the buyer.

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

## Request Syntax


```
{
   "agreementCancellationRequestId": "string",
   "agreementId": "string",
   "cancellationReason": "string"
}
```

## Request Parameters


The request accepts the following data in JSON format.

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

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

 ** [agreementId](#API_marketplace-agreements_CancelAgreementCancellationRequest_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_CancelAgreementCancellationRequest-request-agreementId"></a>
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

 ** [cancellationReason](#API_marketplace-agreements_CancelAgreementCancellationRequest_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_CancelAgreementCancellationRequest-request-cancellationReason"></a>
A required message explaining why the cancellation request is being withdrawn (1-2000 characters).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Pattern: `.+`   
Required: Yes

## Response Syntax


```
{
   "agreementCancellationRequestId": "string",
   "agreementId": "string",
   "createdAt": number,
   "description": "string",
   "reasonCode": "string",
   "status": "string",
   "statusMessage": "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](#API_marketplace-agreements_CancelAgreementCancellationRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_CancelAgreementCancellationRequest-response-agreementCancellationRequestId"></a>
The unique identifier of the cancelled cancellation request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `acr-[a-zA-Z0-9]+` 

 ** [agreementId](#API_marketplace-agreements_CancelAgreementCancellationRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_CancelAgreementCancellationRequest-response-agreementId"></a>
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](#API_marketplace-agreements_CancelAgreementCancellationRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_CancelAgreementCancellationRequest-response-createdAt"></a>
The date and time when the cancellation request was originally created, as a POSIX timestamp (Unix epoch seconds).  
Type: Timestamp

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

 ** [reasonCode](#API_marketplace-agreements_CancelAgreementCancellationRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_CancelAgreementCancellationRequest-response-reasonCode"></a>
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](#API_marketplace-agreements_CancelAgreementCancellationRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_CancelAgreementCancellationRequest-response-status"></a>
The updated status of the cancellation request, which is `CANCELLED`.  
Type: String  
Valid Values: `PENDING_APPROVAL | APPROVED | REJECTED | CANCELLED | VALIDATION_FAILED` 

 ** [statusMessage](#API_marketplace-agreements_CancelAgreementCancellationRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_CancelAgreementCancellationRequest-response-statusMessage"></a>
A message providing additional context about the cancellation request status.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.

 ** [updatedAt](#API_marketplace-agreements_CancelAgreementCancellationRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_CancelAgreementCancellationRequest-response-updatedAt"></a>
The date and time when the cancellation request was cancelled, as a POSIX timestamp (Unix epoch seconds).  
Type: Timestamp

## Errors


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


### Sample request


This example illustrates one usage of CancelAgreementCancellationRequest.

```
{
    "agreementCancellationRequestId": "acr-EXAMPLE752jqvg74yo7k",
    "agreementId": "agmt-EXAMPLE752jqvg74yo7k",
    "cancellationReason": "Requested agreement cancellation by mistake"
}
```

### Sample response


This example illustrates one usage of CancelAgreementCancellationRequest.

```
{
    "agreementCancellationRequestId": "acr-EXAMPLE752jqvg74yo7k",
    "agreementId": "agmt-EXAMPLE752jqvg74yo7k",
    "reasonCode": "PRODUCT_DISCONTINUED",
    "description": "Product is being discontinued and no longer supported",
    "status": "CANCELLED",
    "statusMessage": "Cancellation requested by seller",
    "createdAt": 1736935800,
    "updatedAt": 1737022200
}
```

## See Also


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/CancelAgreementCancellationRequest) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/marketplace-agreement-2020-03-01/CancelAgreementCancellationRequest) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/marketplace-agreement-2020-03-01/CancelAgreementCancellationRequest) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/marketplace-agreement-2020-03-01/CancelAgreementCancellationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/CancelAgreementCancellationRequest) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/marketplace-agreement-2020-03-01/CancelAgreementCancellationRequest) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/marketplace-agreement-2020-03-01/CancelAgreementCancellationRequest) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/marketplace-agreement-2020-03-01/CancelAgreementCancellationRequest) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/CancelAgreementCancellationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/marketplace-agreement-2020-03-01/CancelAgreementCancellationRequest) 

# CancelAgreementPaymentRequest


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


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

## Request Parameters


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


```
{
   "agreementId": "string",
   "chargeAmount": "string",
   "createdAt": number,
   "currencyCode": "string",
   "description": "string",
   "name": "string",
   "paymentRequestId": "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.

 ** [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


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


### Sample request


This example illustrates one usage of CancelAgreementPaymentRequest.

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

### Sample response


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


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) 

# DescribeAgreement


Provides details about an agreement, such as the proposer, acceptor, start date, and end date.

## Request Syntax


```
{
   "agreementId": "string"
}
```

## Request Parameters


The request accepts the following data in JSON format.

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

 ** [agreementId](#API_marketplace-agreements_DescribeAgreement_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_DescribeAgreement-request-agreementId"></a>
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

## Response Syntax


```
{
   "acceptanceTime": number,
   "acceptor": { 
      "accountId": "string"
   },
   "agreementId": "string",
   "agreementType": "string",
   "endTime": number,
   "estimatedCharges": { 
      "agreementValue": "string",
      "currencyCode": "string"
   },
   "proposalSummary": { 
      "offerId": "string",
      "offerSetId": "string",
      "resources": [ 
         { 
            "id": "string",
            "type": "string"
         }
      ]
   },
   "proposer": { 
      "accountId": "string"
   },
   "startTime": number,
   "status": "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.

 ** [acceptanceTime](#API_marketplace-agreements_DescribeAgreement_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_DescribeAgreement-response-acceptanceTime"></a>
The date and time the offer was accepted or the agreement was created.  
 `AcceptanceTime` and `StartTime` can differ for future dated agreements (FDAs).
Type: Timestamp

 ** [acceptor](#API_marketplace-agreements_DescribeAgreement_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_DescribeAgreement-response-acceptor"></a>
The details of the party accepting the agreement terms. This is commonly the buyer for `PurchaseAgreement`.  
Type: [Acceptor](API_marketplace-agreements_Acceptor.md) object

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

 ** [agreementType](#API_marketplace-agreements_DescribeAgreement_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_DescribeAgreement-response-agreementType"></a>
The type of agreement. Values are `PurchaseAgreement` or `VendorInsightsAgreement`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z]+` 

 ** [endTime](#API_marketplace-agreements_DescribeAgreement_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_DescribeAgreement-response-endTime"></a>
The date and time when the agreement ends. The field is `null` for pay-as-you-go agreements, which don’t have end dates.  
Type: Timestamp

 ** [estimatedCharges](#API_marketplace-agreements_DescribeAgreement_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_DescribeAgreement-response-estimatedCharges"></a>
The estimated cost of the agreement.  
Type: [EstimatedCharges](API_marketplace-agreements_EstimatedCharges.md) object

 ** [proposalSummary](#API_marketplace-agreements_DescribeAgreement_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_DescribeAgreement-response-proposalSummary"></a>
A summary of the proposal received from the proposer.  
Type: [ProposalSummary](API_marketplace-agreements_ProposalSummary.md) object

 ** [proposer](#API_marketplace-agreements_DescribeAgreement_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_DescribeAgreement-response-proposer"></a>
The details of the party proposing the agreement terms. This is commonly the seller for `PurchaseAgreement`.  
Type: [Proposer](API_marketplace-agreements_Proposer.md) object

 ** [startTime](#API_marketplace-agreements_DescribeAgreement_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_DescribeAgreement-response-startTime"></a>
The date and time when the agreement starts.  
Type: Timestamp

 ** [status](#API_marketplace-agreements_DescribeAgreement_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_DescribeAgreement-response-status"></a>
The current status of the agreement.  
Statuses include:  
+  `ACTIVE` – The terms of the agreement are active.
+  `ARCHIVED` – The agreement ended without a specified reason.
+  `CANCELLED` – The acceptor ended the agreement before the defined end date.
+  `EXPIRED` – The agreement ended on the defined end date.
+  `RENEWED` – The agreement was renewed into a new agreement (for example, an auto-renewal).
+  `REPLACED` – The agreement was replaced using an agreement replacement offer.
+  `TERMINATED` – The agreement ended before the defined end date because of an AWS termination (for example, a payment failure).
Type: String  
Valid Values: `ACTIVE | ARCHIVED | CANCELLED | EXPIRED | RENEWED | REPLACED | TERMINATED` 

## Errors


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

 ** 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


### Sample request


This example illustrates one usage of DescribeAgreement.

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

### Sample response


This example illustrates one usage of DescribeAgreement.

```
{
   "agreementId": "fEXAMPLE-0aa6-4e42-8715-6a1EXAMPLE95",
   "acceptor": {
        "accountId": "123456789010"
   },
   "proposer": {
        "accountId": "123456789010"
   },
   "startTime": 2019-10-08T21:40:43.644Z,
   "endTime": 2023-10-08T21:40:43.644Z,
   "acceptanceTime": 2019-10-08T00:00:00.000Z,
   "agreementType": "PurchaseAgreement", 
   "proposalSummary": {
       "resources": [
           {
               "id": "0EXAMPLE-8ce8-4814-bcf1-636EXAMPLEb5",
               "type": "AmiProduct" 
           }
       ],
       "offerId": "ABCDEFGHIJKLMNOP123",
       "offerSetId": "KMZQABLKAXWYG3NW516"
   ],
   "status": "ACTIVE",
   "estimatedCharges": {
       "currencyCode": "USD",
       "agreementValue": "1000"
   }
}
```

## See Also


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/DescribeAgreement) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/marketplace-agreement-2020-03-01/DescribeAgreement) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/marketplace-agreement-2020-03-01/DescribeAgreement) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/marketplace-agreement-2020-03-01/DescribeAgreement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/DescribeAgreement) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/marketplace-agreement-2020-03-01/DescribeAgreement) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/marketplace-agreement-2020-03-01/DescribeAgreement) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/marketplace-agreement-2020-03-01/DescribeAgreement) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/DescribeAgreement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/marketplace-agreement-2020-03-01/DescribeAgreement) 

# GetAgreementCancellationRequest


Retrieves detailed information about a specific agreement cancellation request. Both sellers (proposers) and buyers (acceptors) can use this operation to view cancellation requests associated with their agreements.

## Request Syntax


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

## Request Parameters


The request accepts the following data in JSON format.

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

 ** [agreementCancellationRequestId](#API_marketplace-agreements_GetAgreementCancellationRequest_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementCancellationRequest-request-agreementCancellationRequestId"></a>
The unique identifier of the cancellation request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `acr-[a-zA-Z0-9]+`   
Required: Yes

 ** [agreementId](#API_marketplace-agreements_GetAgreementCancellationRequest_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementCancellationRequest-request-agreementId"></a>
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",
   "statusMessage": "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](#API_marketplace-agreements_GetAgreementCancellationRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementCancellationRequest-response-agreementCancellationRequestId"></a>
The unique identifier of the cancellation request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `acr-[a-zA-Z0-9]+` 

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

 ** [createdAt](#API_marketplace-agreements_GetAgreementCancellationRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementCancellationRequest-response-createdAt"></a>
The date and time when the cancellation request was created, as a POSIX timestamp (Unix epoch seconds).  
Type: Timestamp

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

 ** [reasonCode](#API_marketplace-agreements_GetAgreementCancellationRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementCancellationRequest-response-reasonCode"></a>
The reason code provided for the cancellation.  
Type: String  
Valid Values: `INCORRECT_TERMS_ACCEPTED | REPLACING_AGREEMENT | TEST_AGREEMENT | ALTERNATIVE_PROCUREMENT_CHANNEL | PRODUCT_DISCONTINUED | UNINTENDED_RENEWAL | BUYER_DISSATISFACTION | OTHER` 

 ** [status](#API_marketplace-agreements_GetAgreementCancellationRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementCancellationRequest-response-status"></a>
The current status of the cancellation request.  
Type: String  
Valid Values: `PENDING_APPROVAL | APPROVED | REJECTED | CANCELLED | VALIDATION_FAILED` 

 ** [statusMessage](#API_marketplace-agreements_GetAgreementCancellationRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementCancellationRequest-response-statusMessage"></a>
A message providing additional context about the cancellation request status.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.

 ** [updatedAt](#API_marketplace-agreements_GetAgreementCancellationRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementCancellationRequest-response-updatedAt"></a>
The date and time when the cancellation request was last updated, as a POSIX timestamp (Unix epoch seconds).  
Type: Timestamp

## Errors


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

 ** 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


### Sample request


This example illustrates one usage of GetAgreementCancellationRequest.

```
{
    "agreementId": "agmt-EXAMPLE752jqvg74yo7k",
    "agreementCancellationRequestId": "acr-EXAMPLEsgew33rhsds"
}
```

### Sample response


This example illustrates one usage of GetAgreementCancellationRequest.

```
{
    "agreementCancellationRequestId": "acr-EXAMPLEsgew33rhsds",
    "agreementId": "agmt-EXAMPLE752jqvg74yo7k",
    "reasonCode": "PRODUCT_DISCONTINUED",
    "description": "Product is being discontinued and no longer supported",
    "status": "VALIDATION_FAILED",
    "statusMessage": "Agreement is not in an active state",
    "createdAt": 1736935800,
    "updatedAt": 1737022200
}
```

## See Also


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/GetAgreementCancellationRequest) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/marketplace-agreement-2020-03-01/GetAgreementCancellationRequest) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/marketplace-agreement-2020-03-01/GetAgreementCancellationRequest) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/marketplace-agreement-2020-03-01/GetAgreementCancellationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/GetAgreementCancellationRequest) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/marketplace-agreement-2020-03-01/GetAgreementCancellationRequest) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/marketplace-agreement-2020-03-01/GetAgreementCancellationRequest) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/marketplace-agreement-2020-03-01/GetAgreementCancellationRequest) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/GetAgreementCancellationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/marketplace-agreement-2020-03-01/GetAgreementCancellationRequest) 

# GetAgreementPaymentRequest


Retrieves detailed information about a specific payment request. Both sellers (proposers) and buyers (acceptors) can use this operation to view payment requests associated with their agreements. The response includes the current status, charge details, timestamps, and the charge ID if the request has been approved.

**Note**  
The calling identity must be either the acceptor or proposer of the payment request. A `ResourceNotFoundException` is returned if the payment request does not exist.

## Request Syntax


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

## Request Parameters


The request accepts the following data in JSON format.

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

 ** [agreementId](#API_marketplace-agreements_GetAgreementPaymentRequest_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementPaymentRequest-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_GetAgreementPaymentRequest_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementPaymentRequest-request-paymentRequestId"></a>
The identifier of the payment request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `pr-[a-zA-Z0-9]+`   
Required: Yes

## Response Syntax


```
{
   "agreementId": "string",
   "chargeAmount": "string",
   "chargeId": "string",
   "createdAt": number,
   "currencyCode": "string",
   "description": "string",
   "name": "string",
   "paymentRequestId": "string",
   "status": "string",
   "statusMessage": "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.

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

 ** [chargeAmount](#API_marketplace-agreements_GetAgreementPaymentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementPaymentRequest-response-chargeAmount"></a>
The amount charged or to be charged to the buyer.  
Type: String  
Pattern: `[0-9]*(\.[0-9]{0,8})?` 

 ** [chargeId](#API_marketplace-agreements_GetAgreementPaymentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementPaymentRequest-response-chargeId"></a>
The unique identifier of the charge created after the payment request is approved. This field is only present for approved payment requests and follows the pattern `ch-[a-zA-Z0-9]+`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `ch-[a-zA-Z0-9]+` 

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

 ** [currencyCode](#API_marketplace-agreements_GetAgreementPaymentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementPaymentRequest-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_GetAgreementPaymentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementPaymentRequest-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_GetAgreementPaymentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementPaymentRequest-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_GetAgreementPaymentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementPaymentRequest-response-paymentRequestId"></a>
The unique identifier of the payment request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `pr-[a-zA-Z0-9]+` 

 ** [status](#API_marketplace-agreements_GetAgreementPaymentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementPaymentRequest-response-status"></a>
The current status of the payment request. Possible values include:  
+  `VALIDATING` – The payment request is being validated against agreement terms.
+  `VALIDATION_FAILED` – The payment request failed validation.
+  `PENDING_APPROVAL` – The payment request is awaiting buyer action.
+  `APPROVED` – The buyer has approved the payment request.
+  `REJECTED` – The buyer has rejected the payment request.
+  `CANCELLED` – The seller has cancelled the payment request.
Type: String  
Valid Values: `VALIDATING | VALIDATION_FAILED | PENDING_APPROVAL | APPROVED | REJECTED | CANCELLED` 

 ** [statusMessage](#API_marketplace-agreements_GetAgreementPaymentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementPaymentRequest-response-statusMessage"></a>
An optional message providing additional context about the payment request status, such as a rejection reason or validation failure details.  
Type: String

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

## Errors


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

 ** 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


### Sample request


This example illustrates one usage of GetAgreementPaymentRequest.

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

### Sample response


This example illustrates one usage of GetAgreementPaymentRequest.

```
{
    "paymentRequestId": "prEXAMPLE-1bb7-5f53-9826-7b2EXAMPLE06",
    "agreementId": "fEXAMPLE-0aa6-4e42-8715-6a1EXAMPLE95",
    "status": "APPROVED",
    "statusMessage": null,
    "name": "Q1 2024 Usage Charges",
    "description": "Payment request for Q1 2024 usage charges for premium support services",
    "chargeId": "chEXAMPLE-4dd9-7h75-1048-9d4EXAMPLE28",
    "chargeAmount": "1250.50",
    "currencyCode": "USD",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-16T11:45:00.000Z"
}
```

## See Also


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/GetAgreementPaymentRequest) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/marketplace-agreement-2020-03-01/GetAgreementPaymentRequest) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/marketplace-agreement-2020-03-01/GetAgreementPaymentRequest) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/marketplace-agreement-2020-03-01/GetAgreementPaymentRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/GetAgreementPaymentRequest) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/marketplace-agreement-2020-03-01/GetAgreementPaymentRequest) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/marketplace-agreement-2020-03-01/GetAgreementPaymentRequest) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/marketplace-agreement-2020-03-01/GetAgreementPaymentRequest) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/GetAgreementPaymentRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/marketplace-agreement-2020-03-01/GetAgreementPaymentRequest) 

# 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


The request accepts the following data in JSON format.

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

 ** [agreementId](#API_marketplace-agreements_GetAgreementTerms_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementTerms-request-agreementId"></a>
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](#API_marketplace-agreements_GetAgreementTerms_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementTerms-request-maxResults"></a>
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](#API_marketplace-agreements_GetAgreementTerms_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementTerms-request-nextToken"></a>
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](#API_marketplace-agreements_GetAgreementTerms_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementTerms-response-acceptedTerms"></a>
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](API_marketplace-agreements_AcceptedTerm.md) objects

 ** [nextToken](#API_marketplace-agreements_GetAgreementTerms_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetAgreementTerms-response-nextToken"></a>
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+/=_-]+` 

## Errors


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

 ** 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


### 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
}
```

## See Also


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/GetAgreementTerms) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/marketplace-agreement-2020-03-01/GetAgreementTerms) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/marketplace-agreement-2020-03-01/GetAgreementTerms) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/marketplace-agreement-2020-03-01/GetAgreementTerms) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/GetAgreementTerms) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/marketplace-agreement-2020-03-01/GetAgreementTerms) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/marketplace-agreement-2020-03-01/GetAgreementTerms) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/marketplace-agreement-2020-03-01/GetAgreementTerms) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/GetAgreementTerms) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/marketplace-agreement-2020-03-01/GetAgreementTerms) 

# GetBillingAdjustmentRequest


Retrieves detailed information about a specific billing adjustment request. Sellers (proposers) can use this operation to view the status and details of a billing adjustment request they submitted.

## Request Syntax


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

## Request Parameters


The request accepts the following data in JSON format.

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

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

 ** [billingAdjustmentRequestId](#API_marketplace-agreements_GetBillingAdjustmentRequest_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetBillingAdjustmentRequest-request-billingAdjustmentRequestId"></a>
The unique identifier of the billing adjustment request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `ba-[a-zA-Z0-9]+`   
Required: Yes

## Response Syntax


```
{
   "adjustmentAmount": "string",
   "adjustmentReasonCode": "string",
   "agreementId": "string",
   "billingAdjustmentRequestId": "string",
   "createdAt": number,
   "currencyCode": "string",
   "description": "string",
   "originalInvoiceId": "string",
   "status": "string",
   "statusMessage": "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.

 ** [adjustmentAmount](#API_marketplace-agreements_GetBillingAdjustmentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetBillingAdjustmentRequest-response-adjustmentAmount"></a>
The adjustment amount as a string representation of a decimal number.  
Type: String  
Pattern: `[0-9]*(\.[0-9]{0,8})?` 

 ** [adjustmentReasonCode](#API_marketplace-agreements_GetBillingAdjustmentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetBillingAdjustmentRequest-response-adjustmentReasonCode"></a>
The reason code for the billing adjustment.  
Type: String  
Valid Values: `INCORRECT_TERMS_ACCEPTED | INCORRECT_METERING | TEST_ENVIRONMENT_CHARGES | ALTERNATIVE_PROCUREMENT_CHANNEL | UNINTENDED_RENEWAL | BUYER_DISSATISFACTION | OTHER` 

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

 ** [billingAdjustmentRequestId](#API_marketplace-agreements_GetBillingAdjustmentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetBillingAdjustmentRequest-response-billingAdjustmentRequestId"></a>
The unique identifier of the billing adjustment request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `ba-[a-zA-Z0-9]+` 

 ** [createdAt](#API_marketplace-agreements_GetBillingAdjustmentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetBillingAdjustmentRequest-response-createdAt"></a>
The date and time when the billing adjustment request was created, as a POSIX timestamp (Unix epoch seconds).  
Type: Timestamp

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

 ** [originalInvoiceId](#API_marketplace-agreements_GetBillingAdjustmentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetBillingAdjustmentRequest-response-originalInvoiceId"></a>
The identifier of the original invoice being adjusted.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [status](#API_marketplace-agreements_GetBillingAdjustmentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetBillingAdjustmentRequest-response-status"></a>
The current status of the billing adjustment request.  
Type: String  
Valid Values: `PENDING | VALIDATION_FAILED | COMPLETED` 

 ** [updatedAt](#API_marketplace-agreements_GetBillingAdjustmentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetBillingAdjustmentRequest-response-updatedAt"></a>
The date and time when the billing adjustment request was last updated, as a POSIX timestamp (Unix epoch seconds).  
Type: Timestamp

 ** [description](#API_marketplace-agreements_GetBillingAdjustmentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetBillingAdjustmentRequest-response-description"></a>
The detailed description of the billing adjustment reason, if provided.  
Type: String

 ** [statusMessage](#API_marketplace-agreements_GetBillingAdjustmentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_GetBillingAdjustmentRequest-response-statusMessage"></a>
A message providing additional context about the billing adjustment request status. This field is populated only when the status is `VALIDATION_FAILED`.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.

## Errors


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

 ** 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


### Sample request


This example illustrates one usage of GetBillingAdjustmentRequest.

```
{
    "billingAdjustmentRequestId": "ba-EXAMPLE1a2b3c4d5e",
    "agreementId": "agmt-EXAMPLESvIzsqYMyQwI3"
}
```

### Sample response


This example illustrates one usage of GetBillingAdjustmentRequest.

```
{
    "billingAdjustmentRequestId": "ba-EXAMPLE1a2b3c4d5e",
    "agreementId": "agmt-EXAMPLESvIzsqYMyQwI3",
    "adjustmentReasonCode": "OTHER",
    "description": "Customer requested adjustment due to service outage",
    "originalInvoiceId": "E2E20230929a108cfae",
    "adjustmentAmount": "500.00",
    "currencyCode": "USD",
    "status": "PENDING",
    "createdAt": 1750793400,
    "updatedAt": 1750793400
}
```

## See Also


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/GetBillingAdjustmentRequest) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/marketplace-agreement-2020-03-01/GetBillingAdjustmentRequest) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/marketplace-agreement-2020-03-01/GetBillingAdjustmentRequest) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/marketplace-agreement-2020-03-01/GetBillingAdjustmentRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/GetBillingAdjustmentRequest) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/marketplace-agreement-2020-03-01/GetBillingAdjustmentRequest) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/marketplace-agreement-2020-03-01/GetBillingAdjustmentRequest) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/marketplace-agreement-2020-03-01/GetBillingAdjustmentRequest) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/GetBillingAdjustmentRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/marketplace-agreement-2020-03-01/GetBillingAdjustmentRequest) 

# ListAgreementCancellationRequests


Lists agreement cancellation requests available to you as a seller or buyer. Both sellers (proposers) and buyers (acceptors) can use this operation to find cancellation requests by specifying their party type and applying optional filters.

**Note**  
 `PartyType` is a required parameter. A `ValidationException` is returned if `PartyType` is not provided.

## Request Syntax


```
{
   "agreementId": "string",
   "agreementType": "string",
   "catalog": "string",
   "maxResults": number,
   "nextToken": "string",
   "partyType": "string",
   "status": "string"
}
```

## Request Parameters


The request accepts the following data in JSON format.

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

 ** [partyType](#API_marketplace-agreements_ListAgreementCancellationRequests_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementCancellationRequests-request-partyType"></a>
The party type for the cancellation requests. Required parameter. Use `Proposer` to list cancellation requests where you are the seller, or `Acceptor` to list cancellation requests where you are the buyer.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Pattern: `[A-Za-z]+`   
Required: Yes

 ** [agreementId](#API_marketplace-agreements_ListAgreementCancellationRequests_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementCancellationRequests-request-agreementId"></a>
An optional parameter to filter cancellation requests for a specific agreement.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9_/-]+`   
Required: No

 ** [agreementType](#API_marketplace-agreements_ListAgreementCancellationRequests_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementCancellationRequests-request-agreementType"></a>
An optional parameter to filter cancellation requests by agreement type (e.g., `PurchaseAgreement`).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z]+`   
Required: No

 ** [catalog](#API_marketplace-agreements_ListAgreementCancellationRequests_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementCancellationRequests-request-catalog"></a>
An optional parameter to filter cancellation requests by catalog (e.g., `AWSMarketplace`).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9.-]+`   
Required: No

 ** [maxResults](#API_marketplace-agreements_ListAgreementCancellationRequests_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementCancellationRequests-request-maxResults"></a>
The maximum number of cancellation requests to return in the response.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [nextToken](#API_marketplace-agreements_ListAgreementCancellationRequests_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementCancellationRequests-request-nextToken"></a>
A token to specify where to start pagination. Use the `nextToken` value from a previous response to retrieve the next page of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 8192.  
Pattern: `[a-zA-Z0-9+/=_-]+`   
Required: No

 ** [status](#API_marketplace-agreements_ListAgreementCancellationRequests_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementCancellationRequests-request-status"></a>
An optional parameter to filter cancellation requests by status.  
Type: String  
Valid Values: `PENDING_APPROVAL | APPROVED | REJECTED | CANCELLED | VALIDATION_FAILED`   
Required: No

## Response Syntax


```
{
   "items": [ 
      { 
         "agreementCancellationRequestId": "string",
         "agreementId": "string",
         "agreementType": "string",
         "catalog": "string",
         "createdAt": number,
         "reasonCode": "string",
         "status": "string",
         "updatedAt": number
      }
   ],
   "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.

 ** [items](#API_marketplace-agreements_ListAgreementCancellationRequests_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementCancellationRequests-response-items"></a>
An array of `AgreementCancellationRequestSummary` objects containing summary information about each cancellation request.  
Type: Array of [AgreementCancellationRequestSummary](API_marketplace-agreements_AgreementCancellationRequestSummary.md) objects

 ** [nextToken](#API_marketplace-agreements_ListAgreementCancellationRequests_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementCancellationRequests-response-nextToken"></a>
A token to retrieve the next page of results. If `null`, there are no more results to retrieve.  
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](CommonErrors.md).

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

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

 ** 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


### Sample request


This example illustrates one usage of ListAgreementCancellationRequests.

```
{
    "partyType": "Proposer",
    "maxResults": 10
}
```

### Sample response


This example illustrates one usage of ListAgreementCancellationRequests.

```
{
    "items": [
        {
            "agreementCancellationRequestId": "acr-EXAMPLEsgew33rhsds",
            "agreementId": "agmt-EXAMPLE752jqvg74yo7k",
            "status": "PENDING_APPROVAL",
            "reasonCode": "OTHER",
            "agreementType": "PurchaseAgreement",
            "catalog": "AWSMarketplace",
            "createdAt": 1736935800,
            "updatedAt": 1737022200
        }
    ]
}
```

## See Also


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/ListAgreementCancellationRequests) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/marketplace-agreement-2020-03-01/ListAgreementCancellationRequests) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/marketplace-agreement-2020-03-01/ListAgreementCancellationRequests) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/marketplace-agreement-2020-03-01/ListAgreementCancellationRequests) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/ListAgreementCancellationRequests) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/marketplace-agreement-2020-03-01/ListAgreementCancellationRequests) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/marketplace-agreement-2020-03-01/ListAgreementCancellationRequests) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/marketplace-agreement-2020-03-01/ListAgreementCancellationRequests) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/ListAgreementCancellationRequests) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/marketplace-agreement-2020-03-01/ListAgreementCancellationRequests) 

# ListAgreementInvoiceLineItems


Allows sellers (proposers) to retrieve aggregated billing data from AWS Marketplace agreements using flexible grouping. Supports invoice-level aggregation with filtering by billing period, invoice type, and issued date.

**Note**  
The `groupBy` parameter is required and currently supports only `INVOICE_ID` as a value. The `agreementId` parameter is required.

## Request Syntax


```
{
   "afterIssuedTime": number,
   "agreementId": "string",
   "beforeIssuedTime": number,
   "groupBy": "string",
   "invoiceBillingPeriod": { 
      "month": number,
      "year": number
   },
   "invoiceId": "string",
   "invoiceType": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters


The request accepts the following data in JSON format.

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

 ** [agreementId](#API_marketplace-agreements_ListAgreementInvoiceLineItems_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementInvoiceLineItems-request-agreementId"></a>
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

 ** [groupBy](#API_marketplace-agreements_ListAgreementInvoiceLineItems_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementInvoiceLineItems-request-groupBy"></a>
Specifies a grouping strategy for line items. Currently supports `INVOICE_ID`.  
Type: String  
Valid Values: `INVOICE_ID`   
Required: Yes

 ** [afterIssuedTime](#API_marketplace-agreements_ListAgreementInvoiceLineItems_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementInvoiceLineItems-request-afterIssuedTime"></a>
An optional filter for invoices issued after the specified timestamp.  
Type: Timestamp  
Required: No

 ** [beforeIssuedTime](#API_marketplace-agreements_ListAgreementInvoiceLineItems_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementInvoiceLineItems-request-beforeIssuedTime"></a>
An optional filter for invoices issued before the specified timestamp.  
Type: Timestamp  
Required: No

 ** [invoiceBillingPeriod](#API_marketplace-agreements_ListAgreementInvoiceLineItems_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementInvoiceLineItems-request-invoiceBillingPeriod"></a>
An optional filter for the billing period associated with the invoice.  
Type: [InvoiceBillingPeriod](API_marketplace-agreements_InvoiceBillingPeriod.md) object  
Required: No

 ** [invoiceId](#API_marketplace-agreements_ListAgreementInvoiceLineItems_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementInvoiceLineItems-request-invoiceId"></a>
An optional filter to retrieve invoice information for a specific invoice.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9_/-]+`   
Required: No

 ** [invoiceType](#API_marketplace-agreements_ListAgreementInvoiceLineItems_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementInvoiceLineItems-request-invoiceType"></a>
An optional filter for the type of invoice. Valid values are `INVOICE` and `CREDIT_MEMO`.  
Type: String  
Valid Values: `INVOICE | CREDIT_MEMO`   
Required: No

 ** [maxResults](#API_marketplace-agreements_ListAgreementInvoiceLineItems_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementInvoiceLineItems-request-maxResults"></a>
The maximum number of results to return in the response.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [nextToken](#API_marketplace-agreements_ListAgreementInvoiceLineItems_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementInvoiceLineItems-request-nextToken"></a>
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


```
{
   "agreementInvoiceLineItemGroupSummaries": [ 
      { 
         "agreementId": "string",
         "invoiceBillingPeriod": { 
            "month": number,
            "year": number
         },
         "invoiceId": "string",
         "invoiceType": "string",
         "invoicingEntity": { 
            "branchName": "string",
            "legalName": "string"
         },
         "issuedTime": number,
         "pricingCurrencyAmount": { 
            "amount": "string",
            "currencyCode": "string",
            "maxAdjustmentAmount": "string"
         }
      }
   ],
   "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.

 ** [agreementInvoiceLineItemGroupSummaries](#API_marketplace-agreements_ListAgreementInvoiceLineItems_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementInvoiceLineItems-response-agreementInvoiceLineItemGroupSummaries"></a>
A list of grouped billing data objects.  
Type: Array of [AgreementInvoiceLineItemGroupSummary](API_marketplace-agreements_AgreementInvoiceLineItemGroupSummary.md) objects

 ** [nextToken](#API_marketplace-agreements_ListAgreementInvoiceLineItems_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementInvoiceLineItems-response-nextToken"></a>
A token to retrieve the next page of results. If not present, there are no more results available.  
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](CommonErrors.md).

 ** AccessDeniedException **   
User does not have sufficient access to perform this action.    
 ** requestId **   
The unique identifier for the error.
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


### Sample request


This example illustrates one usage of ListAgreementInvoiceLineItems.

```
{
    "agreementId": "agmt-EXAMPLESvIzsqYMyQwI3",
    "groupBy": "INVOICE_ID"
}
```

### Sample response


This example illustrates one usage of ListAgreementInvoiceLineItems.

```
{
    "agreementInvoiceLineItemGroupSummaries": [
        {
            "agreementId": "agmt-EXAMPLESvIzsqYMyQwI3",
            "invoiceId": "E2E20250105a108cfae",
            "pricingCurrencyAmount": {
                "amount": "1080.00",
                "maxAdjustmentAmount": "1000.00",
                "currencyCode": "USD"
            },
            "invoiceBillingPeriod": {
                "month": 1,
                "year": 2025
            },
            "issuedTime": 1736103549,
            "invoiceType": "INVOICE",
            "invoicingEntity": {
                "legalName": "Amazon Web Services, Inc."
            }
        }
    ],
    "nextToken": null
}
```

## See Also


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/ListAgreementInvoiceLineItems) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/marketplace-agreement-2020-03-01/ListAgreementInvoiceLineItems) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/marketplace-agreement-2020-03-01/ListAgreementInvoiceLineItems) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/marketplace-agreement-2020-03-01/ListAgreementInvoiceLineItems) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/ListAgreementInvoiceLineItems) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/marketplace-agreement-2020-03-01/ListAgreementInvoiceLineItems) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/marketplace-agreement-2020-03-01/ListAgreementInvoiceLineItems) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/marketplace-agreement-2020-03-01/ListAgreementInvoiceLineItems) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/ListAgreementInvoiceLineItems) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/marketplace-agreement-2020-03-01/ListAgreementInvoiceLineItems) 

# ListAgreementPaymentRequests


Lists payment requests available to you as a seller or buyer. Both sellers (proposers) and buyers (acceptors) can use this operation to find payment requests by specifying their party type and applying optional parameters.

**Note**  
 `PartyType` is a required parameter. A `ValidationException` is returned if `PartyType` is not provided. Pagination is supported through `maxResults` (1-50, default 50) and `nextToken` parameters.

## Request Syntax


```
{
   "agreementId": "string",
   "agreementType": "string",
   "catalog": "string",
   "maxResults": number,
   "nextToken": "string",
   "partyType": "string",
   "status": "string"
}
```

## Request Parameters


The request accepts the following data in JSON format.

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

 ** [partyType](#API_marketplace-agreements_ListAgreementPaymentRequests_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementPaymentRequests-request-partyType"></a>
The party type for the payment requests. Required parameter. Use `Proposer` to list payment requests where you are the seller, or `Acceptor` to list payment requests where you are the buyer.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Pattern: `[A-Za-z]+`   
Required: Yes

 ** [agreementId](#API_marketplace-agreements_ListAgreementPaymentRequests_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementPaymentRequests-request-agreementId"></a>
An optional parameter to list payment requests for a specific agreement.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9_/-]+`   
Required: No

 ** [agreementType](#API_marketplace-agreements_ListAgreementPaymentRequests_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementPaymentRequests-request-agreementType"></a>
An optional parameter to list payment requests by agreement type (e.g., `PurchaseAgreement`).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z]+`   
Required: No

 ** [catalog](#API_marketplace-agreements_ListAgreementPaymentRequests_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementPaymentRequests-request-catalog"></a>
An optional parameter to list payment requests by catalog (e.g., `AWSMarketplace`).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9.-]+`   
Required: No

 ** [maxResults](#API_marketplace-agreements_ListAgreementPaymentRequests_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementPaymentRequests-request-maxResults"></a>
The maximum number of payment requests to return in a single response (1-50). Default is 50.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [nextToken](#API_marketplace-agreements_ListAgreementPaymentRequests_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementPaymentRequests-request-nextToken"></a>
A token to specify where to start pagination. Use the `nextToken` value from a previous response to retrieve the next page of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 8192.  
Pattern: `[a-zA-Z0-9+/=_-]+`   
Required: No

 ** [status](#API_marketplace-agreements_ListAgreementPaymentRequests_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementPaymentRequests-request-status"></a>
An optional parameter to list payment requests by status. Valid values include `VALIDATING`, `VALIDATION_FAILED`, `PENDING_APPROVAL`, `APPROVED`, `REJECTED`, and `CANCELLED`.  
Type: String  
Valid Values: `VALIDATING | VALIDATION_FAILED | PENDING_APPROVAL | APPROVED | REJECTED | CANCELLED`   
Required: No

## Response Syntax


```
{
   "items": [ 
      { 
         "agreementId": "string",
         "chargeAmount": "string",
         "chargeId": "string",
         "createdAt": number,
         "currencyCode": "string",
         "name": "string",
         "paymentRequestId": "string",
         "status": "string",
         "updatedAt": number
      }
   ],
   "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.

 ** [items](#API_marketplace-agreements_ListAgreementPaymentRequests_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementPaymentRequests-response-items"></a>
An array of `PaymentRequestSummary` objects containing summary information about each payment request.  
Type: Array of [PaymentRequestSummary](API_marketplace-agreements_PaymentRequestSummary.md) objects

 ** [nextToken](#API_marketplace-agreements_ListAgreementPaymentRequests_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListAgreementPaymentRequests-response-nextToken"></a>
A token to retrieve the next page of results. If `null`, there are no more results to retrieve.  
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](CommonErrors.md).

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

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

 ** 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


### Sample request


This example illustrates one usage of ListAgreementPaymentRequests.

```
{
    "partyType": "Proposer",
    "status": "PENDING_APPROVAL",
    "agreementId": "fEXAMPLE-0aa6-4e42-8715-6a1EXAMPLE95",
    "maxResults": 10
}
```

### Sample response


This example illustrates one usage of ListAgreementPaymentRequests.

```
{
    "items": [
        {
            "paymentRequestId": "prEXAMPLE-1bb7-5f53-9826-7b2EXAMPLE06",
            "agreementId": "fEXAMPLE-0aa6-4e42-8715-6a1EXAMPLE95",
            "status": "PENDING_APPROVAL",
            "name": "Q1 2024 Usage Charges",
            "chargeId": null,
            "chargeAmount": "1250.50",
            "currencyCode": "USD",
            "createdAt": "2024-01-15T10:30:00.000Z",
            "updatedAt": "2024-01-15T10:30:00.000Z"
        },
        {
            "paymentRequestId": "prEXAMPLE-2cc8-6h64-0937-8c3EXAMPLE17",
            "agreementId": "fEXAMPLE-0aa6-4e42-8715-6a1EXAMPLE95",
            "status": "APPROVED",
            "name": "Q4 2023 Usage Charges",
            "chargeId": "chEXAMPLE-4dd9-7h75-1048-9d4EXAMPLE28",
            "chargeAmount": "980.25",
            "currencyCode": "USD",
            "createdAt": "2023-12-20T14:15:00.000Z",
            "updatedAt": "2023-12-21T09:30:00.000Z"
        }
    ],
    "nextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ=="
}
```

## See Also


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/ListAgreementPaymentRequests) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/marketplace-agreement-2020-03-01/ListAgreementPaymentRequests) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/marketplace-agreement-2020-03-01/ListAgreementPaymentRequests) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/marketplace-agreement-2020-03-01/ListAgreementPaymentRequests) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/ListAgreementPaymentRequests) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/marketplace-agreement-2020-03-01/ListAgreementPaymentRequests) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/marketplace-agreement-2020-03-01/ListAgreementPaymentRequests) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/marketplace-agreement-2020-03-01/ListAgreementPaymentRequests) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/ListAgreementPaymentRequests) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/marketplace-agreement-2020-03-01/ListAgreementPaymentRequests) 

# ListBillingAdjustmentRequests


Lists billing adjustment requests for a specific agreement. Sellers (proposers) can use this operation to view all billing adjustment requests associated with an agreement.

## Request Syntax


```
{
   "agreementId": "string",
   "agreementType": "string",
   "catalog": "string",
   "createdAfter": number,
   "createdBefore": number,
   "maxResults": number,
   "nextToken": "string",
   "status": "string"
}
```

## Request Parameters


The request accepts the following data in JSON format.

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

 ** [agreementId](#API_marketplace-agreements_ListBillingAdjustmentRequests_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListBillingAdjustmentRequests-request-agreementId"></a>
The unique identifier of the agreement to list billing adjustment requests for.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9_/-]+`   
Required: No

 ** [agreementType](#API_marketplace-agreements_ListBillingAdjustmentRequests_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListBillingAdjustmentRequests-request-agreementType"></a>
An optional filter to return billing adjustment requests by agreement type (e.g., `PurchaseAgreement`).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z]+`   
Required: No

 ** [catalog](#API_marketplace-agreements_ListBillingAdjustmentRequests_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListBillingAdjustmentRequests-request-catalog"></a>
An optional filter to return billing adjustment requests by catalog (e.g., `AWSMarketplace`).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9.-]+`   
Required: No

 ** [createdAfter](#API_marketplace-agreements_ListBillingAdjustmentRequests_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListBillingAdjustmentRequests-request-createdAfter"></a>
An optional filter to return billing adjustment requests created after the specified POSIX timestamp (Unix epoch seconds).  
Type: Timestamp  
Required: No

 ** [createdBefore](#API_marketplace-agreements_ListBillingAdjustmentRequests_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListBillingAdjustmentRequests-request-createdBefore"></a>
An optional filter to return billing adjustment requests created before the specified POSIX timestamp (Unix epoch seconds).  
Type: Timestamp  
Required: No

 ** [maxResults](#API_marketplace-agreements_ListBillingAdjustmentRequests_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListBillingAdjustmentRequests-request-maxResults"></a>
The maximum number of billing adjustment requests to return in the response.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [nextToken](#API_marketplace-agreements_ListBillingAdjustmentRequests_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListBillingAdjustmentRequests-request-nextToken"></a>
A token to specify where to start pagination. Use the `nextToken` value from a previous response to retrieve the next page of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 8192.  
Pattern: `[a-zA-Z0-9+/=_-]+`   
Required: No

 ** [status](#API_marketplace-agreements_ListBillingAdjustmentRequests_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListBillingAdjustmentRequests-request-status"></a>
An optional filter to return billing adjustment requests with the specified status.  
Type: String  
Valid Values: `PENDING | VALIDATION_FAILED | COMPLETED`   
Required: No

## Response Syntax


```
{
   "items": [ 
      { 
         "adjustmentAmount": "string",
         "agreementId": "string",
         "agreementType": "string",
         "billingAdjustmentRequestId": "string",
         "catalog": "string",
         "createdAt": number,
         "currencyCode": "string",
         "originalInvoiceId": "string",
         "status": "string",
         "updatedAt": number
      }
   ],
   "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.

 ** [items](#API_marketplace-agreements_ListBillingAdjustmentRequests_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListBillingAdjustmentRequests-response-items"></a>
An array of `BillingAdjustmentSummary` objects containing summary information about each billing adjustment request.  
Type: Array of [BillingAdjustmentSummary](API_marketplace-agreements_BillingAdjustmentSummary.md) objects

 ** [nextToken](#API_marketplace-agreements_ListBillingAdjustmentRequests_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_ListBillingAdjustmentRequests-response-nextToken"></a>
A token to retrieve the next page of results. If `null`, there are no more results to retrieve.  
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](CommonErrors.md).

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

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

 ** 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


### Sample request


This example illustrates one usage of ListBillingAdjustmentRequests.

```
{
    "agreementId": "agmt-EXAMPLESvIzsqYMyQwI3"
}
```

### Sample response


This example illustrates one usage of ListBillingAdjustmentRequests.

```
{
    "items": [
        {
            "billingAdjustmentRequestId": "ba-EXAMPLE1a2b3c4d5e",
            "status": "PENDING",
            "agreementId": "agmt-EXAMPLESvIzsqYMyQwI3",
            "originalInvoiceId": "E2E20230929a108cfae",
            "adjustmentAmount": "500.00",
            "currencyCode": "USD",
            "createdAt": 1750793400,
            "updatedAt": 1750793400
        },
        {
            "billingAdjustmentRequestId": "ba-EXAMPLE2b3c4d5e6f",
            "status": "PENDING",
            "agreementId": "agmt-EXAMPLESvIzsqYMyQwI3",
            "originalInvoiceId": "E2E20230930b209dfbf",
            "adjustmentAmount": "500.00",
            "currencyCode": "USD",
            "createdAt": 1750793400,
            "updatedAt": 1750793400
        }
    ],
    "nextToken": null
}
```

## See Also


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/ListBillingAdjustmentRequests) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/marketplace-agreement-2020-03-01/ListBillingAdjustmentRequests) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/marketplace-agreement-2020-03-01/ListBillingAdjustmentRequests) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/marketplace-agreement-2020-03-01/ListBillingAdjustmentRequests) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/ListBillingAdjustmentRequests) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/marketplace-agreement-2020-03-01/ListBillingAdjustmentRequests) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/marketplace-agreement-2020-03-01/ListBillingAdjustmentRequests) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/marketplace-agreement-2020-03-01/ListBillingAdjustmentRequests) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/ListBillingAdjustmentRequests) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/marketplace-agreement-2020-03-01/ListBillingAdjustmentRequests) 

# SearchAgreements


Searches across all agreements that a proposer has in AWS Marketplace. The search returns a list of agreements with basic agreement information.

The following filter combinations are supported when the `PartyType` is `Proposer`:
+  `AgreementType` 
+  `AgreementType` \$1 `EndTime` 
+  `AgreementType` \$1 `ResourceType` 
+  `AgreementType` \$1 `ResourceType` \$1 `EndTime` 
+  `AgreementType` \$1 `ResourceType` \$1 `Status` 
+  `AgreementType` \$1 `ResourceType` \$1 `Status` \$1 `EndTime` 
+  `AgreementType` \$1 `ResourceId` 
+  `AgreementType` \$1 `ResourceId` \$1 `EndTime` 
+  `AgreementType` \$1 `ResourceId` \$1 `Status` 
+  `AgreementType` \$1 `ResourceId` \$1 `Status` \$1 `EndTime` 
+  `AgreementType` \$1 `AcceptorAccountId` 
+  `AgreementType` \$1 `AcceptorAccountId` \$1 `EndTime` 
+  `AgreementType` \$1 `AcceptorAccountId` \$1 `Status` 
+  `AgreementType` \$1 `AcceptorAccountId` \$1 `Status` \$1 `EndTime` 
+  `AgreementType` \$1 `AcceptorAccountId` \$1 `OfferId` 
+  `AgreementType` \$1 `AcceptorAccountId` \$1 `OfferId` \$1 `Status` 
+  `AgreementType` \$1 `AcceptorAccountId` \$1 `OfferId` \$1 `EndTime` 
+  `AgreementType` \$1 `AcceptorAccountId` \$1 `OfferId` \$1 `Status` \$1 `EndTime` 
+  `AgreementType` \$1 `AcceptorAccountId` \$1 `ResourceId` 
+  `AgreementType` \$1 `AcceptorAccountId` \$1 `ResourceId` \$1 `Status` 
+  `AgreementType` \$1 `AcceptorAccountId` \$1 `ResourceId` \$1 `EndTime` 
+  `AgreementType` \$1 `AcceptorAccountId` \$1 `ResourceId` \$1 `Status` \$1 `EndTime` 
+  `AgreementType` \$1 `AcceptorAccountId` \$1 `ResourceType` 
+  `AgreementType` \$1 `AcceptorAccountId` \$1 `ResourceType` \$1 `EndTime` 
+  `AgreementType` \$1 `AcceptorAccountId` \$1 `ResourceType` \$1 `Status` 
+  `AgreementType` \$1 `AcceptorAccountId` \$1 `ResourceType` \$1 `Status` \$1 `EndTime` 
+  `AgreementType` \$1 `Status` 
+  `AgreementType` \$1 `Status` \$1 `EndTime` 
+  `AgreementType` \$1 `OfferId` 
+  `AgreementType` \$1 `OfferId` \$1 `EndTime` 
+  `AgreementType` \$1 `OfferId` \$1 `Status` 
+  `AgreementType` \$1 `OfferId` \$1 `Status` \$1 `EndTime` 
+  `AgreementType` \$1 `OfferSetId` 
+  `AgreementType` \$1 `OfferSetId` \$1 `EndTime` 
+  `AgreementType` \$1 `OfferSetId` \$1 `Status` 
+  `AgreementType` \$1 `OfferSetId` \$1 `Status` \$1 `EndTime` 

**Note**  
 To filter by `EndTime`, you can use either `BeforeEndTime` or `AfterEndTime`. Only `EndTime` is supported for sorting.

## Request Syntax


```
{
   "catalog": "string",
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string",
   "sort": { 
      "sortBy": "string",
      "sortOrder": "string"
   }
}
```

## Request Parameters


The request accepts the following data in JSON format.

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

 ** [catalog](#API_marketplace-agreements_SearchAgreements_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SearchAgreements-request-catalog"></a>
The catalog in which the agreement was created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9.-]+`   
Required: No

 ** [filters](#API_marketplace-agreements_SearchAgreements_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SearchAgreements-request-filters"></a>
The filter name and value pair used to return a specific list of results.  
The following filters are supported:  
+  `ResourceIdentifier` – The unique identifier of the resource.
+  `ResourceType` – Type of the resource, which is the product (`AmiProduct`, `ContainerProduct`, `SaaSProduct`, `ProfessionalServicesProduct`, or `MachineLearningProduct`).
+  `PartyType` – The party type of the caller. For agreements where the caller is the proposer, use the `Proposer` filter.
+  `AcceptorAccountId` – The AWS account ID of the party accepting the agreement terms.
+  `OfferId` – The unique identifier of the offer in which the terms are registered in the agreement token.
+  `Status` – The current status of the agreement. Values include `ACTIVE`, `ARCHIVED`, `CANCELLED`, `EXPIRED`, `RENEWED`, `REPLACED`, and `TERMINATED`.
+  `BeforeEndTime` – A date used to filter agreements with a date before the `endTime` of an agreement.
+  `AfterEndTime` – A date used to filter agreements with a date after the `endTime` of an agreement.
+  `AgreementType` – The type of agreement. Supported value includes `PurchaseAgreement`.
+  `OfferSetId` – A unique identifier for the offer set containing this offer. All agreements created from offers in this set include this identifier as context.
Type: Array of [Filter](API_marketplace-agreements_Filter.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: No

 ** [maxResults](#API_marketplace-agreements_SearchAgreements_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SearchAgreements-request-maxResults"></a>
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](#API_marketplace-agreements_SearchAgreements_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SearchAgreements-request-nextToken"></a>
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

 ** [sort](#API_marketplace-agreements_SearchAgreements_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SearchAgreements-request-sort"></a>
An object that contains the `SortBy` and `SortOrder` attributes. Only `EndTime` is supported for `SearchAgreements`. The default sort is `EndTime` descending.  
Type: [Sort](API_marketplace-agreements_Sort.md) object  
Required: No

## Response Syntax


```
{
   "agreementViewSummaries": [ 
      { 
         "acceptanceTime": number,
         "acceptor": { 
            "accountId": "string"
         },
         "agreementId": "string",
         "agreementType": "string",
         "endTime": number,
         "proposalSummary": { 
            "offerId": "string",
            "offerSetId": "string",
            "resources": [ 
               { 
                  "id": "string",
                  "type": "string"
               }
            ]
         },
         "proposer": { 
            "accountId": "string"
         },
         "startTime": number,
         "status": "string"
      }
   ],
   "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.

 ** [agreementViewSummaries](#API_marketplace-agreements_SearchAgreements_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SearchAgreements-response-agreementViewSummaries"></a>
A summary of the agreement, including top-level attributes (for example, the agreement ID, proposer, and acceptor).  
Type: Array of [AgreementViewSummary](API_marketplace-agreements_AgreementViewSummary.md) objects

 ** [nextToken](#API_marketplace-agreements_SearchAgreements_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SearchAgreements-response-nextToken"></a>
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](CommonErrors.md).

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

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

 ** 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


### Sample request


This example illustrates one usage of SearchAgreements.

```
{
    "catalog": "AWSMarketplace",
    "filters": [
        {
            "name": "PartyType",
            "values": ["Proposer"]
        },
        {
            "name": "AfterEndTime",
            "values": ["2019-10-08T00:00:00Z"]
        },
        {
            "name": "AcceptorAccountId",
            "values": ["123456789010"]
        }
    ]
}
```

### Sample response


This example illustrates one usage of SearchAgreements.

```
{
    "agreementViewSummaries": [
       {
            "agreementId": "fEXAMPLE-0aa6-4e42-8715-6a1EXAMPLE95",
            "acceptor": {
                "accountId": "123456789010"
            },
            "proposer": {
                "accountId": "123456789010"
            },
            "startTime": 2019-10-08T21:40:43Z,
            "endTime": 2023-10-08T21:40:43Z,
            "acceptanceTime": 2019-10-08T00:00:00Z,
            "agreementType": "PurchaseAgreement",
            "proposalSummary": {
                "resources": [
                    {
                        "id": "0EXAMPLE-8ce8-4814-bcf1-636EXAMPLEb5",
                        "type": "AmiProduct"
                    }
                ],
                "offerId": "ABCDEFGHIJKLMNOP123",
                "offerSetId": "KMZQABLKAXWYG3NW516"
            },
            "status": "ACTIVE"
       }
    ],
    "nextToken": null
}
```

## See Also


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/SearchAgreements) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/marketplace-agreement-2020-03-01/SearchAgreements) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/marketplace-agreement-2020-03-01/SearchAgreements) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/marketplace-agreement-2020-03-01/SearchAgreements) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/SearchAgreements) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/marketplace-agreement-2020-03-01/SearchAgreements) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/marketplace-agreement-2020-03-01/SearchAgreements) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/marketplace-agreement-2020-03-01/SearchAgreements) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/SearchAgreements) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/marketplace-agreement-2020-03-01/SearchAgreements) 

# SendAgreementCancellationRequest


Allows sellers (proposers) to submit a cancellation request for an active agreement. The cancellation request is created in `PENDING_APPROVAL` status, at which point the buyer can review it.

## Request Syntax


```
{
   "agreementId": "string",
   "clientToken": "string",
   "description": "string",
   "reasonCode": "string"
}
```

## Request Parameters


The request accepts the following data in JSON format.

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

 ** [agreementId](#API_marketplace-agreements_SendAgreementCancellationRequest_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SendAgreementCancellationRequest-request-agreementId"></a>
The unique identifier of the agreement for which the cancellation request is being submitted.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9_/-]+`   
Required: Yes

 ** [reasonCode](#API_marketplace-agreements_SendAgreementCancellationRequest_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SendAgreementCancellationRequest-request-reasonCode"></a>
The reason code for the cancellation request.  
Type: String  
Valid Values: `INCORRECT_TERMS_ACCEPTED | REPLACING_AGREEMENT | TEST_AGREEMENT | ALTERNATIVE_PROCUREMENT_CHANNEL | PRODUCT_DISCONTINUED | UNINTENDED_RENEWAL | BUYER_DISSATISFACTION | OTHER`   
Required: Yes

 ** [clientToken](#API_marketplace-agreements_SendAgreementCancellationRequest_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SendAgreementCancellationRequest-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: No

 ** [description](#API_marketplace-agreements_SendAgreementCancellationRequest_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SendAgreementCancellationRequest-request-description"></a>
An optional detailed description of the cancellation reason (1-2000 characters).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Pattern: `.+`   
Required: No

## 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](#API_marketplace-agreements_SendAgreementCancellationRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SendAgreementCancellationRequest-response-agreementCancellationRequestId"></a>
The unique identifier for the created cancellation request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `acr-[a-zA-Z0-9]+` 

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

 ** [createdAt](#API_marketplace-agreements_SendAgreementCancellationRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SendAgreementCancellationRequest-response-createdAt"></a>
The time when the cancellation request was created, as a POSIX timestamp (Unix epoch seconds).  
Type: Timestamp

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

 ** [reasonCode](#API_marketplace-agreements_SendAgreementCancellationRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SendAgreementCancellationRequest-response-reasonCode"></a>
The reason code provided for the cancellation.  
Type: String  
Valid Values: `INCORRECT_TERMS_ACCEPTED | REPLACING_AGREEMENT | TEST_AGREEMENT | ALTERNATIVE_PROCUREMENT_CHANNEL | PRODUCT_DISCONTINUED | UNINTENDED_RENEWAL | BUYER_DISSATISFACTION | OTHER` 

 ** [status](#API_marketplace-agreements_SendAgreementCancellationRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SendAgreementCancellationRequest-response-status"></a>
The current status of the cancellation request. The initial status is `PENDING_APPROVAL`.  
Type: String  
Valid Values: `PENDING_APPROVAL | APPROVED | REJECTED | CANCELLED | VALIDATION_FAILED` 

 ** [updatedAt](#API_marketplace-agreements_SendAgreementCancellationRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SendAgreementCancellationRequest-response-updatedAt"></a>
The time when the cancellation request was last updated, as a POSIX timestamp (Unix epoch seconds).  
Type: Timestamp

## Errors


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


### Sample request


This example illustrates one usage of SendAgreementCancellationRequest.

```
{
    "agreementId": "agmt-EXAMPLE752jqvg74yo7k",
    "reasonCode": "OTHER",
    "description": "Due to budget constraints, we are unable to continue with our current subscription",
    "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
```

### Sample response


This example illustrates one usage of SendAgreementCancellationRequest.

```
{
    "agreementId": "agmt-EXAMPLE752jqvg74yo7k",
    "agreementCancellationRequestId": "acr-EXAMPLE752jqvg74yo7k",
    "status": "PENDING_APPROVAL",
    "reasonCode": "OTHER",
    "description": "Due to budget constraints, we are unable to continue with our current subscription",
    "createdAt": 1736935800,
    "updatedAt": 1736935800
}
```

## See Also


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/SendAgreementCancellationRequest) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/marketplace-agreement-2020-03-01/SendAgreementCancellationRequest) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/marketplace-agreement-2020-03-01/SendAgreementCancellationRequest) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/marketplace-agreement-2020-03-01/SendAgreementCancellationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/SendAgreementCancellationRequest) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/marketplace-agreement-2020-03-01/SendAgreementCancellationRequest) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/marketplace-agreement-2020-03-01/SendAgreementCancellationRequest) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/marketplace-agreement-2020-03-01/SendAgreementCancellationRequest) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/SendAgreementCancellationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/marketplace-agreement-2020-03-01/SendAgreementCancellationRequest) 

# SendAgreementPaymentRequest


Allows sellers (proposers) to submit a payment request to buyers (acceptors) for a specific charge amount for an agreement that includes a `VariablePaymentTerm`. The payment request is created in `PENDING_APPROVAL` status, at which point the buyer can accept or reject it.

**Note**  
The agreement must be active and have a `VariablePaymentTerm` to support payment requests. The `chargeAmount` must not exceed the remaining available balance under the `VariablePaymentTerm` `maxTotalChargeAmount`.

## Request Syntax


```
{
   "agreementId": "string",
   "chargeAmount": "string",
   "clientToken": "string",
   "description": "string",
   "name": "string",
   "termId": "string"
}
```

## Request Parameters


The request accepts the following data in JSON format.

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

 ** [agreementId](#API_marketplace-agreements_SendAgreementPaymentRequest_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SendAgreementPaymentRequest-request-agreementId"></a>
The unique identifier of the agreement for which the payment request is being submitted. Use `GetAgreementTerms` to retrieve agreement term details.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9_/-]+`   
Required: Yes

 ** [chargeAmount](#API_marketplace-agreements_SendAgreementPaymentRequest_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SendAgreementPaymentRequest-request-chargeAmount"></a>
The amount requested to be charged to the buyer, positive decimal value in the currency of the accepted term.  
A `ValidationException` is returned if the `chargeAmount` exceeds the available balance, if the agreement doesn't have an active `VariablePaymentTerm`, or if the `termId` is invalid.
Type: String  
Pattern: `[0-9]*(\.[0-9]{0,8})?`   
Required: Yes

 ** [name](#API_marketplace-agreements_SendAgreementPaymentRequest_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SendAgreementPaymentRequest-request-name"></a>
A descriptive name for the payment request (5-64 characters).  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 64.  
Pattern: `.+`   
Required: Yes

 ** [termId](#API_marketplace-agreements_SendAgreementPaymentRequest_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SendAgreementPaymentRequest-request-termId"></a>
The unique identifier of the `VariablePaymentTerm` for the agreement that the payment request is being sent for.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[A-Za-z0-9+=;,.@\-_]+`   
Required: Yes

 ** [clientToken](#API_marketplace-agreements_SendAgreementPaymentRequest_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SendAgreementPaymentRequest-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]+`   
Required: No

 ** [description](#API_marketplace-agreements_SendAgreementPaymentRequest_RequestSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SendAgreementPaymentRequest-request-description"></a>
An optional detailed description of the payment request (1-2000 characters).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Pattern: `.+`   
Required: No

## Response Syntax


```
{
   "agreementId": "string",
   "chargeAmount": "string",
   "createdAt": number,
   "currencyCode": "string",
   "description": "string",
   "name": "string",
   "paymentRequestId": "string",
   "status": "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.

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

 ** [chargeAmount](#API_marketplace-agreements_SendAgreementPaymentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SendAgreementPaymentRequest-response-chargeAmount"></a>
The amount being charged to the buyer.  
Type: String  
Pattern: `[0-9]*(\.[0-9]{0,8})?` 

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

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

 ** [description](#API_marketplace-agreements_SendAgreementPaymentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SendAgreementPaymentRequest-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_SendAgreementPaymentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SendAgreementPaymentRequest-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_SendAgreementPaymentRequest_ResponseSyntax) **   <a name="AWSMarketplaceService-marketplace-agreements_SendAgreementPaymentRequest-response-paymentRequestId"></a>
The unique identifier for the sent payment request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `pr-[a-zA-Z0-9]+` 

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

## Errors


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


### Sample request


This example illustrates one usage of SendAgreementPaymentRequest.

```
{
    "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "agreementId": "fEXAMPLE-0aa6-4e42-8715-6a1EXAMPLE95",
    "termId": "termEXAMPLE-3cc8-6g64-0937-8c3EXAMPLE17",
    "name": "Q1 2024 Usage Charges",
    "chargeAmount": "1250.50",
    "description": "Payment request for Q1 2024 usage charges for premium support services"
}
```

### Sample response


This example illustrates one usage of SendAgreementPaymentRequest.

```
{
    "paymentRequestId": "prEXAMPLE-1bb7-5f53-9826-7b2EXAMPLE06",
    "agreementId": "fEXAMPLE-0aa6-4e42-8715-6a1EXAMPLE95",
    "status": "PENDING_APPROVAL",
    "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"
}
```

## See Also


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/SendAgreementPaymentRequest) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/marketplace-agreement-2020-03-01/SendAgreementPaymentRequest) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/marketplace-agreement-2020-03-01/SendAgreementPaymentRequest) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/marketplace-agreement-2020-03-01/SendAgreementPaymentRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/marketplace-agreement-2020-03-01/SendAgreementPaymentRequest) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/marketplace-agreement-2020-03-01/SendAgreementPaymentRequest) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/marketplace-agreement-2020-03-01/SendAgreementPaymentRequest) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/marketplace-agreement-2020-03-01/SendAgreementPaymentRequest) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/marketplace-agreement-2020-03-01/SendAgreementPaymentRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/marketplace-agreement-2020-03-01/SendAgreementPaymentRequest)