AgreementService / Client / get_billing_adjustment_request

get_billing_adjustment_request

AgreementService.Client.get_billing_adjustment_request(**kwargs)

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.

Note

A ResourceNotFoundException is returned if the billing adjustment request does not exist or the caller does not have permission to access it.

See also: AWS API Documentation

Request Syntax

response = client.get_billing_adjustment_request(
    agreementId='string',
    billingAdjustmentRequestId='string'
)

Parameters:

• agreementId (string) –

  [REQUIRED]

  The unique identifier of the agreement associated with the billing adjustment request.

• billingAdjustmentRequestId (string) –

  [REQUIRED]

  The unique identifier of the billing adjustment request.

Return type:

dict

Returns:

Response Syntax

{
    'billingAdjustmentRequestId': 'string',
    'agreementId': 'string',
    'adjustmentReasonCode': 'INCORRECT_TERMS_ACCEPTED'|'INCORRECT_METERING'|'TEST_ENVIRONMENT_CHARGES'|'ALTERNATIVE_PROCUREMENT_CHANNEL'|'UNINTENDED_RENEWAL'|'BUYER_DISSATISFACTION'|'OTHER',
    'description': 'string',
    'originalInvoiceId': 'string',
    'adjustmentAmount': 'string',
    'currencyCode': 'string',
    'status': 'PENDING'|'VALIDATION_FAILED'|'COMPLETED',
    'statusMessage': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • billingAdjustmentRequestId (string) –

    The unique identifier of the billing adjustment request.

  • agreementId (string) –

    The unique identifier of the agreement associated with this billing adjustment request.

  • adjustmentReasonCode (string) –

    The reason code for the billing adjustment.

  • description (string) –

    The detailed description of the billing adjustment reason, if provided.

  • originalInvoiceId (string) –

    The identifier of the original invoice being adjusted.

  • adjustmentAmount (string) –

    The adjustment amount as a string representation of a decimal number.

  • currencyCode (string) –

    The currency code for the adjustment amount (e.g., USD).

  • status (string) –

    The current status of the billing adjustment request.

  • statusMessage (string) –

    A message providing additional context about the billing adjustment request status. This field is populated only when the status is VALIDATION_FAILED.

  • createdAt (datetime) –

    The date and time when the billing adjustment request was created, as a POSIX timestamp (Unix epoch seconds).

  • updatedAt (datetime) –

    The date and time when the billing adjustment request was last updated, as a POSIX timestamp (Unix epoch seconds).

Exceptions

• AgreementService.Client.exceptions.ValidationException

• AgreementService.Client.exceptions.AccessDeniedException

• AgreementService.Client.exceptions.ResourceNotFoundException

• AgreementService.Client.exceptions.ThrottlingException

• AgreementService.Client.exceptions.InternalServerException