AWS API Changes

2026/03/25 - AWS Marketplace Agreement Service - 4 new api methods

Changes The Variable Payments APIs enable AWS Marketplace Sellers to perform manage their payment requests (send, get, list, cancel).

ListAgreementPaymentRequests (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.list_agreement_payment_requests(
    partyType='string',
    agreementType='string',
    catalog='string',
    agreementId='string',
    status='VALIDATING'|'VALIDATION_FAILED'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'CANCELLED',
    maxResults=123,
    nextToken='string'
)

type partyType:

string

param partyType:

[REQUIRED]

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 agreementType:

string

param agreementType:

An optional parameter to list payment requests by agreement type (e.g., PurchaseAgreement).

type catalog:

string

param catalog:

An optional parameter to list payment requests by catalog (e.g., AWSMarketplace).

type agreementId:

string

param agreementId:

An optional parameter to list payment requests for a specific agreement.

type status:

string

param status:

An optional parameter to list payment requests by status. Valid values include VALIDATING, VALIDATION_FAILED, PENDING_APPROVAL, APPROVED, REJECTED, and CANCELLED.

type maxResults:

integer

param maxResults:

The maximum number of payment requests to return in a single response (1-50). Default is 50.

type nextToken:

string

param nextToken:

A token to specify where to start pagination. Use the nextToken value from a previous response to retrieve the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'items': [
        {
            'paymentRequestId': 'string',
            'agreementId': 'string',
            'status': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'CANCELLED',
            'name': 'string',
            'chargeId': 'string',
            'chargeAmount': 'string',
            'currencyCode': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  A token to retrieve the next page of results. If null, there are no more results to retrieve.
- items (list) --
  
  An array of PaymentRequestSummary objects containing summary information about each payment request.
  - (dict) --
    
    Summary view of a payment request.
    - paymentRequestId (string) --
      
      The unique identifier of the payment request.
    - agreementId (string) --
      
      The unique identifier of the agreement associated with this payment request.
    - status (string) --
      
      The current status of the payment request. Possible values include VALIDATING, VALIDATION_FAILED, PENDING_APPROVAL, APPROVED, REJECTED, and CANCELLED.
    - name (string) --
      
      The descriptive name of the payment request.
    - chargeId (string) --
      
      The unique identifier of the charge created after the payment request is approved. This field is only present for approved payment requests.
    - chargeAmount (string) --
      
      The amount charged or to be charged to the buyer.
    - currencyCode (string) --
      
      The currency code for the charge amount.
    - createdAt (datetime) --
      
      The date and time when the payment request was created, in ISO 8601 format.
    - updatedAt (datetime) --
      
      The date and time when the payment request was last updated, in ISO 8601 format.

CancelAgreementPaymentRequest (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.cancel_agreement_payment_request(
    paymentRequestId='string',
    agreementId='string'
)

type paymentRequestId:

string

param paymentRequestId:

[REQUIRED]

The unique identifier of the payment request to cancel.

type agreementId:

string

param agreementId:

[REQUIRED]

The unique identifier of the agreement associated with the payment request.

rtype:

dict

returns:

Response Syntax

{
    'paymentRequestId': 'string',
    'agreementId': 'string',
    'status': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'CANCELLED',
    'name': 'string',
    'description': 'string',
    'chargeAmount': 'string',
    'currencyCode': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- paymentRequestId (string) --
  
  The unique identifier of the cancelled payment request.
- agreementId (string) --
  
  The unique identifier of the agreement associated with this payment request.
- status (string) --
  
  The updated status of the payment request, which is CANCELLED.
- name (string) --
  
  The descriptive name of the payment request.
- description (string) --
  
  The detailed description of the payment request, if provided.
- chargeAmount (string) --
  
  The amount that was requested to be charged.
- currencyCode (string) --
  
  The currency code for the charge amount.
- createdAt (datetime) --
  
  The date and time when the payment request was originally created, in ISO 8601 format.
- updatedAt (datetime) --
  
  The date and time when the payment request was cancelled, in ISO 8601 format.

SendAgreementPaymentRequest (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.send_agreement_payment_request(
    clientToken='string',
    agreementId='string',
    termId='string',
    name='string',
    chargeAmount='string',
    description='string'
)

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

type agreementId:

string

param agreementId:

[REQUIRED]

The unique identifier of the agreement for which the payment request is being submitted. Use GetAgreementTerms to retrieve agreement term details.

type termId:

string

param termId:

[REQUIRED]

The unique identifier of the VariablePaymentTerm for the agreement that the payment request is being sent for.

type name:

string

param name:

[REQUIRED]

A descriptive name for the payment request (5-64 characters).

type chargeAmount:

string

param chargeAmount:

[REQUIRED]

The amount requested to be charged to the buyer, positive decimal value in the currency of the accepted term.

type description:

string

param description:

An optional detailed description of the payment request (1-2000 characters).

rtype:

dict

returns:

Response Syntax

{
    'paymentRequestId': 'string',
    'agreementId': 'string',
    'status': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'CANCELLED',
    'name': 'string',
    'description': 'string',
    'chargeAmount': 'string',
    'currencyCode': 'string',
    'createdAt': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- paymentRequestId (string) --
  
  The unique identifier for the sent payment request.
- agreementId (string) --
  
  The agreement identifier for this payment request.
- status (string) --
  
  The current status of the payment request. The initial status is PENDING_APPROVAL.
- name (string) --
  
  The descriptive name of the payment request.
- description (string) --
  
  The detailed description of the payment request, if provided.
- chargeAmount (string) --
  
  The amount being charged to the buyer.
- currencyCode (string) --
  
  The currency code for the charge amount (e.g., USD).
- createdAt (datetime) --
  
  The time when the payment request was created, in ISO 8601 format.

GetAgreementPaymentRequest (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.get_agreement_payment_request(
    paymentRequestId='string',
    agreementId='string'
)

type paymentRequestId:

string

param paymentRequestId:

[REQUIRED]

The identifier of the payment request.

type agreementId:

string

param agreementId:

[REQUIRED]

The unique identifier of the agreement associated with the payment request.

rtype:

dict

returns:

Response Syntax

{
    'paymentRequestId': 'string',
    'agreementId': 'string',
    'status': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'CANCELLED',
    'statusMessage': 'string',
    'name': 'string',
    'description': 'string',
    'chargeId': 'string',
    'chargeAmount': 'string',
    'currencyCode': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- paymentRequestId (string) --
  
  The unique identifier of the payment request.
- agreementId (string) --
  
  The unique identifier of the agreement associated with this payment request. Use DescribeAgreement to retrieve full agreement details.
- status (string) --
  
  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.
- statusMessage (string) --
  
  An optional message providing additional context about the payment request status, such as a rejection reason or validation failure details.
- name (string) --
  
  The descriptive name of the payment request.
- description (string) --
  
  The detailed description of the payment request, if provided.
- chargeId (string) --
  
  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]+.
- chargeAmount (string) --
  
  The amount charged or to be charged to the buyer.
- currencyCode (string) --
  
  The currency code for the charge amount.
- createdAt (datetime) --
  
  The date and time when the payment request was created, in ISO 8601 format.
- updatedAt (datetime) --
  
  The date and time when the payment request was last updated, in ISO 8601 format.