Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

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

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

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

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

An optional filter to return billing adjustment requests created after the specified timestamp.

Type: Timestamp

Required: No

createdBefore

An optional filter to return billing adjustment requests created before the specified timestamp.

Type: Timestamp

Required: No

maxResults

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

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

status

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

An array of BillingAdjustmentSummary objects containing summary information about each billing adjustment request.

Type: Array of BillingAdjustmentSummary objects

nextToken

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.

AccessDeniedException

User does not have sufficient access to perform this action.

message: Description of the error.
reason: The reason for the access denied exception.
requestId: The unique identifier for the error.

HTTP Status Code: 400

InternalServerException

Unexpected error during processing of request.

message: Description of the error.
requestId: The unique identifier for the error.

HTTP Status Code: 500

ThrottlingException

Request was denied due to request throttling.

message: Description of the error.
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.
message: Description of 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
}