AgreementService / Client / list_billing_adjustment_requests

list_billing_adjustment_requests

AgreementService.Client.list_billing_adjustment_requests(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_billing_adjustment_requests(
    agreementId='string',
    status='PENDING'|'VALIDATION_FAILED'|'COMPLETED',
    createdAfter=datetime(2015, 1, 1),
    createdBefore=datetime(2015, 1, 1),
    maxResults=123,
    catalog='string',
    agreementType='string',
    nextToken='string'
)
Parameters:

  • agreementId (string) – The unique identifier of the agreement to list billing adjustment requests for.

  • status (string) – An optional filter to return billing adjustment requests with the specified status.

  • createdAfter (datetime) – An optional filter to return billing adjustment requests created after the specified timestamp.

  • createdBefore (datetime) – An optional filter to return billing adjustment requests created before the specified timestamp.

  • maxResults (integer) – The maximum number of billing adjustment requests to return in the response.

  • catalog (string) – An optional filter to return billing adjustment requests by catalog (e.g., AWSMarketplace).

  • agreementType (string) – An optional filter to return billing adjustment requests by agreement type (e.g., PurchaseAgreement).

  • nextToken (string) – A token to specify where to start pagination.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'items': [
        {
            'billingAdjustmentRequestId': 'string',
            'originalInvoiceId': 'string',
            'adjustmentAmount': 'string',
            'currencyCode': 'string',
            'status': 'PENDING'|'VALIDATION_FAILED'|'COMPLETED',
            'agreementId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'agreementType': 'string',
            'catalog': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      The token used for pagination. The field is null if there are no more results.

    • items (list) –

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

      • (dict) –

        Summary view of a billing adjustment request.

        • billingAdjustmentRequestId (string) –

          The unique identifier of the billing adjustment request.

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

        • status (string) –

          The current status of the billing adjustment request.

        • agreementId (string) –

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

        • createdAt (datetime) –

          The date and time when the billing adjustment request was created.

        • updatedAt (datetime) –

          The date and time when the billing adjustment request was last updated.

        • agreementType (string) –

          The type of agreement.

        • catalog (string) –

          The catalog in which the agreement was created.

Exceptions

  • AgreementService.Client.exceptions.ValidationException

  • AgreementService.Client.exceptions.AccessDeniedException

  • AgreementService.Client.exceptions.ThrottlingException

  • AgreementService.Client.exceptions.InternalServerException