BatchCreateBillingAdjustmentRequest

$result = $client->batchCreateBillingAdjustmentRequest([/* ... */]);
$promise = $client->batchCreateBillingAdjustmentRequestAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchCreateBillingAdjustmentRequest([
    'billingAdjustmentRequestEntries' => [ // REQUIRED
        [
            'adjustmentAmount' => '<string>', // REQUIRED
            'adjustmentReasonCode' => 'INCORRECT_TERMS_ACCEPTED|INCORRECT_METERING|TEST_ENVIRONMENT_CHARGES|ALTERNATIVE_PROCUREMENT_CHANNEL|UNINTENDED_RENEWAL|BUYER_DISSATISFACTION|OTHER', // REQUIRED
            'agreementId' => '<string>', // REQUIRED
            'clientToken' => '<string>', // REQUIRED
            'currencyCode' => '<string>', // REQUIRED
            'description' => '<string>',
            'originalInvoiceId' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'clientToken' => '<string>',
            'code' => 'CONFLICT_EXCEPTION|VALIDATION_EXCEPTION|RESOURCE_NOT_FOUND_EXCEPTION|INTERNAL_FAILURE',
            'message' => '<string>',
        ],
        // ...
    ],
    'items' => [
        [
            'billingAdjustmentRequestId' => '<string>',
            'clientToken' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

InternalServerException:

Unexpected error during processing of request.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

Examples

Example 1: Create billing adjustment requests

$result = $client->batchCreateBillingAdjustmentRequest([
    'billingAdjustmentRequestEntries' => [
        [
            'adjustmentAmount' => '500.00',
            'adjustmentReasonCode' => 'OTHER',
            'agreementId' => 'agmt-SvIzsqYMyQwI3GWgJAe17URx',
            'clientToken' => '71a5e82e-a49b-4075-8c7f-52df1d294379',
            'currencyCode' => 'USD',
            'description' => 'Customer requested adjustment due to service outage during critical business period.',
            'originalInvoiceId' => 'E2E20230929a108cfae',
        ],
    ],
]);

Result syntax:

[
    'errors' => [
    ],
    'items' => [
        [
            'billingAdjustmentRequestId' => 'ba-1a2b3c4d5e6f7g',
            'clientToken' => '71a5e82e-a49b-4075-8c7f-52df1d294379',
        ],
    ],
]

CancelAgreementCancellationRequest

$result = $client->cancelAgreementCancellationRequest([/* ... */]);
$promise = $client->cancelAgreementCancellationRequestAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->cancelAgreementCancellationRequest([
    'agreementCancellationRequestId' => '<string>', // REQUIRED
    'agreementId' => '<string>', // REQUIRED
    'cancellationReason' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'agreementCancellationRequestId' => '<string>',
    'agreementId' => '<string>',
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'reasonCode' => 'INCORRECT_TERMS_ACCEPTED|REPLACING_AGREEMENT|TEST_AGREEMENT|ALTERNATIVE_PROCUREMENT_CHANNEL|PRODUCT_DISCONTINUED|UNINTENDED_RENEWAL|BUYER_DISSATISFACTION|OTHER',
    'status' => 'PENDING_APPROVAL|APPROVED|REJECTED|CANCELLED|VALIDATION_FAILED',
    'statusMessage' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

User does not have sufficient access to perform this action.

ResourceNotFoundException:

Request references a resource which does not exist.

ThrottlingException:

Request was denied due to request throttling.

InternalServerException:

Unexpected error during processing of request.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

Examples

Example 1: Cancel a cancellation request

$result = $client->cancelAgreementCancellationRequest([
    'agreementCancellationRequestId' => 'acr-752jqvg74yo7k4h56cakk6396',
    'agreementId' => 'agmt-752jqvg74yo7k4h56cakk6396',
    'cancellationReason' => 'Requested agreement cancellation by mistake',
]);

Result syntax:

[
    'agreementCancellationRequestId' => 'acr-752jqvg74yo7k4h56cakk6396',
    'agreementId' => 'agmt-752jqvg74yo7k4h56cakk6396',
    'createdAt' => ,
    'description' => 'Product is being discontinued and no longer supported',
    'reasonCode' => 'PRODUCT_DISCONTINUED',
    'status' => 'CANCELLED',
    'statusMessage' => 'Cancellation requested by seller',
    'updatedAt' => ,
]

CancelAgreementPaymentRequest

$result = $client->cancelAgreementPaymentRequest([/* ... */]);
$promise = $client->cancelAgreementPaymentRequestAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->cancelAgreementPaymentRequest([
    'agreementId' => '<string>', // REQUIRED
    'paymentRequestId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'agreementId' => '<string>',
    'chargeAmount' => '<string>',
    'createdAt' => <DateTime>,
    'currencyCode' => '<string>',
    'description' => '<string>',
    'name' => '<string>',
    'paymentRequestId' => '<string>',
    'status' => 'VALIDATING|VALIDATION_FAILED|PENDING_APPROVAL|APPROVED|REJECTED|CANCELLED',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

User does not have sufficient access to perform this action.

ResourceNotFoundException:

Request references a resource which does not exist.

ThrottlingException:

Request was denied due to request throttling.

InternalServerException:

Unexpected error during processing of request.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

DescribeAgreement

$result = $client->describeAgreement([/* ... */]);
$promise = $client->describeAgreementAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeAgreement([
    'agreementId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'acceptanceTime' => <DateTime>,
    'acceptor' => [
        'accountId' => '<string>',
    ],
    'agreementId' => '<string>',
    'agreementType' => '<string>',
    'endTime' => <DateTime>,
    'estimatedCharges' => [
        'agreementValue' => '<string>',
        'currencyCode' => '<string>',
    ],
    'proposalSummary' => [
        'offerId' => '<string>',
        'offerSetId' => '<string>',
        'resources' => [
            [
                'id' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
    ],
    'proposer' => [
        'accountId' => '<string>',
    ],
    'startTime' => <DateTime>,
    'status' => 'ACTIVE|ARCHIVED|CANCELLED|EXPIRED|RENEWED|REPLACED|ROLLED_BACK|SUPERSEDED|TERMINATED',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

User does not have sufficient access to perform this action.

ResourceNotFoundException:

Request references a resource which does not exist.

ThrottlingException:

Request was denied due to request throttling.

InternalServerException:

Unexpected error during processing of request.

GetAgreementCancellationRequest

$result = $client->getAgreementCancellationRequest([/* ... */]);
$promise = $client->getAgreementCancellationRequestAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getAgreementCancellationRequest([
    'agreementCancellationRequestId' => '<string>', // REQUIRED
    'agreementId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'agreementCancellationRequestId' => '<string>',
    'agreementId' => '<string>',
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'reasonCode' => 'INCORRECT_TERMS_ACCEPTED|REPLACING_AGREEMENT|TEST_AGREEMENT|ALTERNATIVE_PROCUREMENT_CHANNEL|PRODUCT_DISCONTINUED|UNINTENDED_RENEWAL|BUYER_DISSATISFACTION|OTHER',
    'status' => 'PENDING_APPROVAL|APPROVED|REJECTED|CANCELLED|VALIDATION_FAILED',
    'statusMessage' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

User does not have sufficient access to perform this action.

ResourceNotFoundException:

Request references a resource which does not exist.

ThrottlingException:

Request was denied due to request throttling.

InternalServerException:

Unexpected error during processing of request.

Examples

Example 1: Get a cancellation request

$result = $client->getAgreementCancellationRequest([
    'agreementCancellationRequestId' => 'acr-sgew33rhsds',
    'agreementId' => 'agmt-752jqvg74yo7k',
]);

Result syntax:

[
    'agreementCancellationRequestId' => 'acr-sgew33rhsds',
    'agreementId' => 'agmt-752jqvg74yo7k',
    'createdAt' => ,
    'description' => 'Product is being discontinued and no longer supported',
    'reasonCode' => 'PRODUCT_DISCONTINUED',
    'status' => 'VALIDATION_FAILED',
    'statusMessage' => 'Agreement is not in an active state',
    'updatedAt' => ,
]

GetAgreementPaymentRequest

$result = $client->getAgreementPaymentRequest([/* ... */]);
$promise = $client->getAgreementPaymentRequestAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getAgreementPaymentRequest([
    'agreementId' => '<string>', // REQUIRED
    'paymentRequestId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'agreementId' => '<string>',
    'chargeAmount' => '<string>',
    'chargeId' => '<string>',
    'createdAt' => <DateTime>,
    'currencyCode' => '<string>',
    'description' => '<string>',
    'name' => '<string>',
    'paymentRequestId' => '<string>',
    'status' => 'VALIDATING|VALIDATION_FAILED|PENDING_APPROVAL|APPROVED|REJECTED|CANCELLED',
    'statusMessage' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

User does not have sufficient access to perform this action.

ResourceNotFoundException:

Request references a resource which does not exist.

ThrottlingException:

Request was denied due to request throttling.

InternalServerException:

Unexpected error during processing of request.

GetAgreementTerms

$result = $client->getAgreementTerms([/* ... */]);
$promise = $client->getAgreementTermsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getAgreementTerms([
    'agreementId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'acceptedTerms' => [
        [
            'byolPricingTerm' => [
                'type' => '<string>',
            ],
            'configurableUpfrontPricingTerm' => [
                'configuration' => [
                    'dimensions' => [
                        [
                            'dimensionKey' => '<string>',
                            'dimensionValue' => <integer>,
                        ],
                        // ...
                    ],
                    'selectorValue' => '<string>',
                ],
                'currencyCode' => '<string>',
                'rateCards' => [
                    [
                        'constraints' => [
                            'multipleDimensionSelection' => '<string>',
                            'quantityConfiguration' => '<string>',
                        ],
                        'rateCard' => [
                            [
                                'dimensionKey' => '<string>',
                                'price' => '<string>',
                            ],
                            // ...
                        ],
                        'selector' => [
                            'type' => '<string>',
                            'value' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'type' => '<string>',
            ],
            'fixedUpfrontPricingTerm' => [
                'currencyCode' => '<string>',
                'duration' => '<string>',
                'grants' => [
                    [
                        'dimensionKey' => '<string>',
                        'maxQuantity' => <integer>,
                    ],
                    // ...
                ],
                'price' => '<string>',
                'type' => '<string>',
            ],
            'freeTrialPricingTerm' => [
                'duration' => '<string>',
                'grants' => [
                    [
                        'dimensionKey' => '<string>',
                        'maxQuantity' => <integer>,
                    ],
                    // ...
                ],
                'type' => '<string>',
            ],
            'legalTerm' => [
                'documents' => [
                    [
                        'type' => '<string>',
                        'url' => '<string>',
                        'version' => '<string>',
                    ],
                    // ...
                ],
                'type' => '<string>',
            ],
            'paymentScheduleTerm' => [
                'currencyCode' => '<string>',
                'schedule' => [
                    [
                        'chargeAmount' => '<string>',
                        'chargeDate' => <DateTime>,
                    ],
                    // ...
                ],
                'type' => '<string>',
            ],
            'recurringPaymentTerm' => [
                'billingPeriod' => '<string>',
                'currencyCode' => '<string>',
                'price' => '<string>',
                'type' => '<string>',
            ],
            'renewalTerm' => [
                'configuration' => [
                    'enableAutoRenew' => true || false,
                ],
                'type' => '<string>',
            ],
            'supportTerm' => [
                'refundPolicy' => '<string>',
                'type' => '<string>',
            ],
            'usageBasedPricingTerm' => [
                'currencyCode' => '<string>',
                'rateCards' => [
                    [
                        'rateCard' => [
                            [
                                'dimensionKey' => '<string>',
                                'price' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'type' => '<string>',
            ],
            'validityTerm' => [
                'agreementDuration' => '<string>',
                'agreementEndDate' => <DateTime>,
                'agreementStartDate' => <DateTime>,
                'type' => '<string>',
            ],
            'variablePaymentTerm' => [
                'configuration' => [
                    'expirationDuration' => '<string>',
                    'paymentRequestApprovalStrategy' => 'AUTO_APPROVE_ON_EXPIRATION|WAIT_FOR_APPROVAL',
                ],
                'currencyCode' => '<string>',
                'maxTotalChargeAmount' => '<string>',
                'type' => '<string>',
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

User does not have sufficient access to perform this action.

ResourceNotFoundException:

Request references a resource which does not exist.

ThrottlingException:

Request was denied due to request throttling.

InternalServerException:

Unexpected error during processing of request.

GetBillingAdjustmentRequest

$result = $client->getBillingAdjustmentRequest([/* ... */]);
$promise = $client->getBillingAdjustmentRequestAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getBillingAdjustmentRequest([
    'agreementId' => '<string>', // REQUIRED
    'billingAdjustmentRequestId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'adjustmentAmount' => '<string>',
    'adjustmentReasonCode' => 'INCORRECT_TERMS_ACCEPTED|INCORRECT_METERING|TEST_ENVIRONMENT_CHARGES|ALTERNATIVE_PROCUREMENT_CHANNEL|UNINTENDED_RENEWAL|BUYER_DISSATISFACTION|OTHER',
    'agreementId' => '<string>',
    'billingAdjustmentRequestId' => '<string>',
    'createdAt' => <DateTime>,
    'currencyCode' => '<string>',
    'description' => '<string>',
    'originalInvoiceId' => '<string>',
    'status' => 'PENDING|VALIDATION_FAILED|COMPLETED',
    'statusMessage' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

User does not have sufficient access to perform this action.

ResourceNotFoundException:

Request references a resource which does not exist.

ThrottlingException:

Request was denied due to request throttling.

InternalServerException:

Unexpected error during processing of request.

Examples

Example 1: Get a billing adjustment request

$result = $client->getBillingAdjustmentRequest([
    'agreementId' => 'agmt-SvIzsqYMyQwI3GWgJAe17URx',
    'billingAdjustmentRequestId' => 'ba-1a2b3c4d5e6f7g',
]);

Result syntax:

[
    'adjustmentAmount' => '500.00',
    'adjustmentReasonCode' => 'OTHER',
    'agreementId' => 'agmt-SvIzsqYMyQwI3GWgJAe17URx',
    'billingAdjustmentRequestId' => 'ba-1a2b3c4d5e6f7g',
    'createdAt' => ,
    'currencyCode' => 'USD',
    'description' => 'Customer requested adjustment',
    'originalInvoiceId' => 'E2E20230929a108cfae',
    'status' => 'PENDING',
    'updatedAt' => ,
]

ListAgreementCancellationRequests

$result = $client->listAgreementCancellationRequests([/* ... */]);
$promise = $client->listAgreementCancellationRequestsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listAgreementCancellationRequests([
    'agreementId' => '<string>',
    'agreementType' => '<string>',
    'catalog' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'partyType' => '<string>', // REQUIRED
    'status' => 'PENDING_APPROVAL|APPROVED|REJECTED|CANCELLED|VALIDATION_FAILED',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'agreementCancellationRequestId' => '<string>',
            'agreementId' => '<string>',
            'agreementType' => '<string>',
            'catalog' => '<string>',
            'createdAt' => <DateTime>,
            'reasonCode' => 'INCORRECT_TERMS_ACCEPTED|REPLACING_AGREEMENT|TEST_AGREEMENT|ALTERNATIVE_PROCUREMENT_CHANNEL|PRODUCT_DISCONTINUED|UNINTENDED_RENEWAL|BUYER_DISSATISFACTION|OTHER',
            'status' => 'PENDING_APPROVAL|APPROVED|REJECTED|CANCELLED|VALIDATION_FAILED',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

InternalServerException:

Unexpected error during processing of request.

Examples

Example 1: List cancellation requests

$result = $client->listAgreementCancellationRequests([
    'maxResults' => 10,
    'partyType' => 'Proposer',
]);

Result syntax:

[
    'items' => [
        [
            'agreementCancellationRequestId' => 'acr-sgew33rhsds',
            'agreementId' => 'agmt-752jqvg74yo7k',
            'agreementType' => 'PurchaseAgreement',
            'catalog' => 'AWSMarketplace',
            'createdAt' => ,
            'reasonCode' => 'OTHER',
            'status' => 'PENDING_APPROVAL',
            'updatedAt' => ,
        ],
    ],
]

ListAgreementInvoiceLineItems

$result = $client->listAgreementInvoiceLineItems([/* ... */]);
$promise = $client->listAgreementInvoiceLineItemsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listAgreementInvoiceLineItems([
    'afterIssuedTime' => <integer || string || DateTime>,
    'agreementId' => '<string>', // REQUIRED
    'beforeIssuedTime' => <integer || string || DateTime>,
    'groupBy' => 'INVOICE_ID', // REQUIRED
    'invoiceBillingPeriod' => [
        'month' => <integer>, // REQUIRED
        'year' => <integer>, // REQUIRED
    ],
    'invoiceId' => '<string>',
    'invoiceType' => 'INVOICE|CREDIT_MEMO',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'agreementInvoiceLineItemGroupSummaries' => [
        [
            'agreementId' => '<string>',
            'invoiceBillingPeriod' => [
                'month' => <integer>,
                'year' => <integer>,
            ],
            'invoiceId' => '<string>',
            'invoiceType' => 'INVOICE|CREDIT_MEMO',
            'invoicingEntity' => [
                'branchName' => '<string>',
                'legalName' => '<string>',
            ],
            'issuedTime' => <DateTime>,
            'pricingCurrencyAmount' => [
                'amount' => '<string>',
                'currencyCode' => '<string>',
                'maxAdjustmentAmount' => '<string>',
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

Examples

Example 1: List agreement invoice line items

$result = $client->listAgreementInvoiceLineItems([
    'agreementId' => 'agmt-EXAMPLESvIzsqYMyQwI3',
    'groupBy' => 'INVOICE_ID',
]);

Result syntax:

[
    'agreementInvoiceLineItemGroupSummaries' => [
        [
            'agreementId' => 'agmt-EXAMPLESvIzsqYMyQwI3',
            'invoiceBillingPeriod' => [
                'month' => 1,
                'year' => 2025,
            ],
            'invoiceId' => 'E2E20250105a108cfae',
            'invoiceType' => 'INVOICE',
            'invoicingEntity' => [
                'legalName' => 'Amazon Web Services, Inc.',
            ],
            'issuedTime' => ,
            'pricingCurrencyAmount' => [
                'amount' => '1080.00',
                'currencyCode' => 'USD',
                'maxAdjustmentAmount' => '1000.00',
            ],
        ],
    ],
]

ListAgreementPaymentRequests

$result = $client->listAgreementPaymentRequests([/* ... */]);
$promise = $client->listAgreementPaymentRequestsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listAgreementPaymentRequests([
    'agreementId' => '<string>',
    'agreementType' => '<string>',
    'catalog' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'partyType' => '<string>', // REQUIRED
    'status' => 'VALIDATING|VALIDATION_FAILED|PENDING_APPROVAL|APPROVED|REJECTED|CANCELLED',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'agreementId' => '<string>',
            'chargeAmount' => '<string>',
            'chargeId' => '<string>',
            'createdAt' => <DateTime>,
            'currencyCode' => '<string>',
            'name' => '<string>',
            'paymentRequestId' => '<string>',
            'status' => 'VALIDATING|VALIDATION_FAILED|PENDING_APPROVAL|APPROVED|REJECTED|CANCELLED',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

InternalServerException:

Unexpected error during processing of request.

ListBillingAdjustmentRequests

$result = $client->listBillingAdjustmentRequests([/* ... */]);
$promise = $client->listBillingAdjustmentRequestsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listBillingAdjustmentRequests([
    'agreementId' => '<string>',
    'agreementType' => '<string>',
    'catalog' => '<string>',
    'createdAfter' => <integer || string || DateTime>,
    'createdBefore' => <integer || string || DateTime>,
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'status' => 'PENDING|VALIDATION_FAILED|COMPLETED',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'adjustmentAmount' => '<string>',
            'agreementId' => '<string>',
            'agreementType' => '<string>',
            'billingAdjustmentRequestId' => '<string>',
            'catalog' => '<string>',
            'createdAt' => <DateTime>,
            'currencyCode' => '<string>',
            'originalInvoiceId' => '<string>',
            'status' => 'PENDING|VALIDATION_FAILED|COMPLETED',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

InternalServerException:

Unexpected error during processing of request.

Examples

Example 1: List billing adjustment requests

$result = $client->listBillingAdjustmentRequests([
    'agreementId' => 'agmt-SvIzsqYMyQwI3GWgJAe17URx',
]);

Result syntax:

[
    'items' => [
        [
            'adjustmentAmount' => '500.00',
            'agreementId' => 'agmt-SvIzsqYMyQwI3GWgJAe17URx',
            'agreementType' => 'PurchaseAgreement',
            'billingAdjustmentRequestId' => 'ba-1a2b3c4d5e6f7g',
            'catalog' => 'AWSMarketplace',
            'createdAt' => ,
            'currencyCode' => 'USD',
            'originalInvoiceId' => 'E2E20230929a108cfae',
            'status' => 'PENDING',
            'updatedAt' => ,
        ],
    ],
]

SearchAgreements

$result = $client->searchAgreements([/* ... */]);
$promise = $client->searchAgreementsAsync([/* ... */]);

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 + EndTime

• AgreementType + ResourceType

• AgreementType + ResourceType + EndTime

• AgreementType + ResourceType + Status

• AgreementType + ResourceType + Status + EndTime

• AgreementType + ResourceId

• AgreementType + ResourceId + EndTime

• AgreementType + ResourceId + Status

• AgreementType + ResourceId + Status + EndTime

• AgreementType + AcceptorAccountId

• AgreementType + AcceptorAccountId + EndTime

• AgreementType + AcceptorAccountId + Status

• AgreementType + AcceptorAccountId + Status + EndTime

• AgreementType + AcceptorAccountId + OfferId

• AgreementType + AcceptorAccountId + OfferId + Status

• AgreementType + AcceptorAccountId + OfferId + EndTime

• AgreementType + AcceptorAccountId + OfferId + Status + EndTime

• AgreementType + AcceptorAccountId + ResourceId

• AgreementType + AcceptorAccountId + ResourceId + Status

• AgreementType + AcceptorAccountId + ResourceId + EndTime

• AgreementType + AcceptorAccountId + ResourceId + Status + EndTime

• AgreementType + AcceptorAccountId + ResourceType

• AgreementType + AcceptorAccountId + ResourceType + EndTime

• AgreementType + AcceptorAccountId + ResourceType + Status

• AgreementType + AcceptorAccountId + ResourceType + Status + EndTime

• AgreementType + Status

• AgreementType + Status + EndTime

• AgreementType + OfferId

• AgreementType + OfferId + EndTime

• AgreementType + OfferId + Status

• AgreementType + OfferId + Status + EndTime

• AgreementType + OfferSetId

• AgreementType + OfferSetId + EndTime

• AgreementType + OfferSetId + Status

• AgreementType + OfferSetId + Status + EndTime

Parameter Syntax

$result = $client->searchAgreements([
    'catalog' => '<string>',
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sort' => [
        'sortBy' => '<string>',
        'sortOrder' => 'ASCENDING|DESCENDING',
    ],
]);

Parameter Details

Result Syntax

[
    'agreementViewSummaries' => [
        [
            'acceptanceTime' => <DateTime>,
            'acceptor' => [
                'accountId' => '<string>',
            ],
            'agreementId' => '<string>',
            'agreementType' => '<string>',
            'endTime' => <DateTime>,
            'proposalSummary' => [
                'offerId' => '<string>',
                'offerSetId' => '<string>',
                'resources' => [
                    [
                        'id' => '<string>',
                        'type' => '<string>',
                    ],
                    // ...
                ],
            ],
            'proposer' => [
                'accountId' => '<string>',
            ],
            'startTime' => <DateTime>,
            'status' => 'ACTIVE|ARCHIVED|CANCELLED|EXPIRED|RENEWED|REPLACED|ROLLED_BACK|SUPERSEDED|TERMINATED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

InternalServerException:

Unexpected error during processing of request.

SendAgreementCancellationRequest

$result = $client->sendAgreementCancellationRequest([/* ... */]);
$promise = $client->sendAgreementCancellationRequestAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->sendAgreementCancellationRequest([
    'agreementId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'description' => '<string>',
    'reasonCode' => 'INCORRECT_TERMS_ACCEPTED|REPLACING_AGREEMENT|TEST_AGREEMENT|ALTERNATIVE_PROCUREMENT_CHANNEL|PRODUCT_DISCONTINUED|UNINTENDED_RENEWAL|BUYER_DISSATISFACTION|OTHER', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'agreementCancellationRequestId' => '<string>',
    'agreementId' => '<string>',
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'reasonCode' => 'INCORRECT_TERMS_ACCEPTED|REPLACING_AGREEMENT|TEST_AGREEMENT|ALTERNATIVE_PROCUREMENT_CHANNEL|PRODUCT_DISCONTINUED|UNINTENDED_RENEWAL|BUYER_DISSATISFACTION|OTHER',
    'status' => 'PENDING_APPROVAL|APPROVED|REJECTED|CANCELLED|VALIDATION_FAILED',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

User does not have sufficient access to perform this action.

ResourceNotFoundException:

Request references a resource which does not exist.

ThrottlingException:

Request was denied due to request throttling.

InternalServerException:

Unexpected error during processing of request.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

Examples

Example 1: Send a cancellation request

$result = $client->sendAgreementCancellationRequest([
    'agreementId' => 'agmt-752jqvg74yo7k4h56cakk6396',
    'clientToken' => '53nQSKWt6AjrsiZPhzQyZT',
    'description' => 'Due to budget constraints, we are unable to continue with our current subscription',
    'reasonCode' => 'OTHER',
]);

Result syntax:

[
    'agreementCancellationRequestId' => 'acr-752jqvg74yo7k4h56cakk6396',
    'agreementId' => 'agmt-752jqvg74yo7k4h56cakk6396',
    'createdAt' => ,
    'description' => 'Due to budget constraints, we are unable to continue with our current subscription',
    'reasonCode' => 'OTHER',
    'status' => 'PENDING_APPROVAL',
    'updatedAt' => ,
]

SendAgreementPaymentRequest

$result = $client->sendAgreementPaymentRequest([/* ... */]);
$promise = $client->sendAgreementPaymentRequestAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->sendAgreementPaymentRequest([
    'agreementId' => '<string>', // REQUIRED
    'chargeAmount' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'termId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'agreementId' => '<string>',
    'chargeAmount' => '<string>',
    'createdAt' => <DateTime>,
    'currencyCode' => '<string>',
    'description' => '<string>',
    'name' => '<string>',
    'paymentRequestId' => '<string>',
    'status' => 'VALIDATING|VALIDATION_FAILED|PENDING_APPROVAL|APPROVED|REJECTED|CANCELLED',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

AccessDeniedException:

User does not have sufficient access to perform this action.

ResourceNotFoundException:

Request references a resource which does not exist.

ThrottlingException:

Request was denied due to request throttling.

InternalServerException:

Unexpected error during processing of request.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.