agreement_payment_requests

Creates, updates, deletes, gets or lists an agreement_payment_requests resource.

Overview

Name	agreement_payment_requests
Type	Resource
Id	aws.marketplace_agreement.agreement_payment_requests

Fields

The following fields are returned by SELECT queries:

get_agreement_payment_request

Name	Datatype	Description
name	string	The descriptive name of the payment request. (pattern: <code>.+</code>)
agreement_id	string	The unique identifier of the agreement associated with this payment request. Use DescribeAgreement to retrieve full agreement details. (pattern: <code>[A-Za-z0-9_/-]+</code>)
charge_amount	string	The amount charged or to be charged to the buyer. (pattern: <code>[0-9]*(.[0-9]{0,8})?</code>)
charge_id	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]+. (pattern: <code>ch-[a-zA-Z0-9]+</code>)
created_at	string (date-time)	The date and time when the payment request was created.
currency_code	string	The currency code for the charge amount. (pattern: <code>[A-Z]+</code>)
description	string	The detailed description of the payment request, if provided.
payment_request_id	string	The unique identifier of the payment request. (pattern: <code>pr-[a-zA-Z0-9]+</code>)
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. (VALIDATING, VALIDATION_FAILED, PENDING_APPROVAL, APPROVED, REJECTED, CANCELLED)
status_message	string	An optional message providing additional context about the payment request status, such as a rejection reason or validation failure details.
updated_at	string (date-time)	The date and time when the payment request was last updated.

list_agreement_payment_requests

Name	Datatype	Description
name	string	The descriptive name of the payment request. (pattern: <code>.+</code>)
agreement_id	string	The unique identifier of the agreement associated with this payment request. (pattern: <code>[A-Za-z0-9_/-]+</code>)
charge_amount	string	The amount charged or to be charged to the buyer. (pattern: <code>[0-9]*(.[0-9]{0,8})?</code>)
charge_id	string	The unique identifier of the charge created after the payment request is approved. This field is only present for approved payment requests. (pattern: <code>ch-[a-zA-Z0-9]+</code>)
created_at	string (date-time)	The date and time when the payment request was created.
currency_code	string	The currency code for the charge amount. (pattern: <code>[A-Z]+</code>)
payment_request_id	string	The unique identifier of the payment request. (pattern: <code>pr-[a-zA-Z0-9]+</code>)
status	string	The current status of the payment request. Possible values include VALIDATING, VALIDATION_FAILED, PENDING_APPROVAL, APPROVED, REJECTED, and CANCELLED. (VALIDATING, VALIDATION_FAILED, PENDING_APPROVAL, APPROVED, REJECTED, CANCELLED)
updated_at	string (date-time)	The date and time when the payment request was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_agreement_payment_request	select	region		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. 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.
list_agreement_payment_requests	select	region		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. 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_agreement_payment_request

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

SELECT
name,
agreement_id,
charge_amount,
charge_id,
created_at,
currency_code,
description,
payment_request_id,
status,
status_message,
updated_at
FROM aws.marketplace_agreement.agreement_payment_requests
WHERE region = '{{ region }}' -- required
;

list_agreement_payment_requests

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

SELECT
name,
agreement_id,
charge_amount,
charge_id,
created_at,
currency_code,
payment_request_id,
status,
updated_at
FROM aws.marketplace_agreement.agreement_payment_requests
WHERE region = '{{ region }}' -- required
;