billing_adjustment_requests

Creates, updates, deletes, gets or lists a billing_adjustment_requests resource.

Overview

Name	billing_adjustment_requests
Type	Resource
Id	aws.marketplace_agreement.billing_adjustment_requests

Fields

The following fields are returned by SELECT queries:

get_billing_adjustment_request

Name	Datatype	Description
adjustment_amount	string	The adjustment amount as a string representation of a decimal number. (pattern: <code>[0-9]*(.[0-9]{0,8})?</code>)
adjustment_reason_code	string	The reason code for the billing adjustment. (INCORRECT_TERMS_ACCEPTED, INCORRECT_METERING, TEST_ENVIRONMENT_CHARGES, ALTERNATIVE_PROCUREMENT_CHANNEL, UNINTENDED_RENEWAL, BUYER_DISSATISFACTION, OTHER)
agreement_id	string	The unique identifier of the agreement associated with this billing adjustment request. (pattern: <code>[A-Za-z0-9_/-]+</code>)
billing_adjustment_request_id	string	The unique identifier of the billing adjustment request. (pattern: <code>ba-[a-zA-Z0-9]+</code>)
created_at	string (date-time)	The date and time when the billing adjustment request was created.
currency_code	string	The currency code for the adjustment amount (e.g., USD). (pattern: <code>[A-Z]+</code>)
description	string	The detailed description of the billing adjustment reason, if provided.
original_invoice_id	string	The identifier of the original invoice being adjusted.
status	string	The current status of the billing adjustment request. (PENDING, VALIDATION_FAILED, COMPLETED)
status_message	string	A message providing additional context about the billing adjustment request status. This field is populated only when the status is VALIDATION_FAILED.
updated_at	string (date-time)	The date and time when the billing adjustment request was last updated.

list_billing_adjustment_requests

Name	Datatype	Description
adjustment_amount	string	The adjustment amount as a string representation of a decimal number. (pattern: <code>[0-9]*(.[0-9]{0,8})?</code>)
agreement_id	string	The unique identifier of the agreement associated with this billing adjustment request. (pattern: <code>[A-Za-z0-9_/-]+</code>)
agreement_type	string	The type of agreement. (pattern: <code>[A-Za-z]+</code>)
billing_adjustment_request_id	string	The unique identifier of the billing adjustment request. (pattern: <code>ba-[a-zA-Z0-9]+</code>)
catalog	string	The catalog in which the agreement was created. (pattern: <code>[a-zA-Z0-9.-]+</code>)
created_at	string (date-time)	The date and time when the billing adjustment request was created.
currency_code	string	The currency code for the adjustment amount. (pattern: <code>[A-Z]+</code>)
original_invoice_id	string	The identifier of the original invoice being adjusted.
status	string	The current status of the billing adjustment request. (PENDING, VALIDATION_FAILED, COMPLETED)
updated_at	string (date-time)	The date and time when the billing adjustment request was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_billing_adjustment_request	select	region		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.
list_billing_adjustment_requests	select	region		Lists billing adjustment requests for a specific agreement. Sellers (proposers) can use this operation to view all billing adjustment requests associated with an agreement.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_billing_adjustment_request

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.

SELECT
adjustment_amount,
adjustment_reason_code,
agreement_id,
billing_adjustment_request_id,
created_at,
currency_code,
description,
original_invoice_id,
status,
status_message,
updated_at
FROM aws.marketplace_agreement.billing_adjustment_requests
WHERE region = '{{ region }}' -- required
;

list_billing_adjustment_requests

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

SELECT
adjustment_amount,
agreement_id,
agreement_type,
billing_adjustment_request_id,
catalog,
created_at,
currency_code,
original_invoice_id,
status,
updated_at
FROM aws.marketplace_agreement.billing_adjustment_requests
WHERE region = '{{ region }}' -- required
;