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
For information about the parameters that are common to all actions, see Common 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 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
-
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
-
The adjustment amount as a string representation of a decimal number.
Type: String
Pattern:
[0-9]*(\.[0-9]{0,8})? - adjustmentReasonCode
-
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
-
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
-
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
-
The date and time when the billing adjustment request was created.
Type: Timestamp
- currencyCode
-
The currency code for the adjustment amount (e.g.,
USD).Type: String
Length Constraints: Fixed length of 3.
Pattern:
[A-Z]+ - originalInvoiceId
-
The identifier of the original invoice being adjusted.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
- status
-
The current status of the billing adjustment request.
Type: String
Valid Values:
PENDING | VALIDATION_FAILED | COMPLETED - updatedAt
-
The date and time when the billing adjustment request was last updated.
Type: Timestamp
- description
-
The detailed description of the billing adjustment reason, if provided.
Type: String
- statusMessage
-
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.
- 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
- ResourceNotFoundException
-
Request references a resource which does not exist.
- message
-
Description of the error.
- 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.
- 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 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:
