[ aws . marketplace-agreement ]

batch-create-billing-adjustment-request

Description

Allows sellers (proposers) to submit billing adjustment requests for one or more invoices within an agreement. Each entry in the batch specifies an invoice and the adjustment amount. The operation returns successfully created adjustment request IDs and any errors for entries that failed validation.

Note

Each entry requires a unique clientToken for idempotency. A ValidationException is returned if the adjustment amount exceeds the maximum refundable amount for the invoice.

See also: AWS API Documentation

Synopsis

  batch-create-billing-adjustment-request
--billing-adjustment-request-entries <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--billing-adjustment-request-entries (list) [required]

A list of billing adjustment request entries. Each entry specifies the invoice and adjustment details.

(structure)

An individual entry in a batch billing adjustment request, specifying the invoice and adjustment details.

agreementId -> (string) [required]

The unique identifier of the agreement associated with the invoice.

Constraints:

• min: 1
• max: 64
• pattern: [A-Za-z0-9_/-]+

originalInvoiceId -> (string) [required]

The identifier of the original invoice to adjust.

Constraints:

• min: 1
• max: 255

adjustmentAmount -> (string) [required]

The adjustment amount as a string representation of a decimal number in the currency of the invoice.

Constraints:

• pattern: [0-9]*(\.[0-9]{0,8})?

currencyCode -> (string) [required]

The 3-letter ISO 4217 currency code for the adjustment amount (e.g., USD ).

Constraints:

• min: 3
• max: 3
• pattern: [A-Z]+

adjustmentReasonCode -> (string) [required]

The reason code for the billing adjustment. Valid values include INCORRECT_TERMS_ACCEPTED , INCORRECT_METERING , TEST_ENVIRONMENT_CHARGES , ALTERNATIVE_PROCUREMENT_CHANNEL , UNINTENDED_RENEWAL , BUYER_DISSATISFACTION , and OTHER .

Possible values:

• INCORRECT_TERMS_ACCEPTED
• INCORRECT_METERING
• TEST_ENVIRONMENT_CHARGES
• ALTERNATIVE_PROCUREMENT_CHANNEL
• UNINTENDED_RENEWAL
• BUYER_DISSATISFACTION
• OTHER

description -> (string)

An optional detailed description of the adjustment reason.

Constraints:

• min: 0
• max: 500
• pattern: .+

clientToken -> (string) [required]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Constraints:

• min: 1
• max: 64
• pattern: [a-zA-Z0-9-]+

Shorthand Syntax:

agreementId=string,originalInvoiceId=string,adjustmentAmount=string,currencyCode=string,adjustmentReasonCode=string,description=string,clientToken=string ...

JSON Syntax:

[
  {
    "agreementId": "string",
    "originalInvoiceId": "string",
    "adjustmentAmount": "string",
    "currencyCode": "string",
    "adjustmentReasonCode": "INCORRECT_TERMS_ACCEPTED"|"INCORRECT_METERING"|"TEST_ENVIRONMENT_CHARGES"|"ALTERNATIVE_PROCUREMENT_CHANNEL"|"UNINTENDED_RENEWAL"|"BUYER_DISSATISFACTION"|"OTHER",
    "description": "string",
    "clientToken": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream
• off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

Output

items -> (list)

A list of successfully created billing adjustment items, each containing the billingAdjustmentRequestId and clientToken .

(structure)

A successfully created billing adjustment request item.

billingAdjustmentRequestId -> (string) [required]

The unique identifier of the created billing adjustment request.

Constraints:

• min: 1
• max: 64
• pattern: ba-[a-zA-Z0-9]+

clientToken -> (string) [required]

The client token provided in the corresponding request entry.

Constraints:

• min: 1
• max: 64
• pattern: [a-zA-Z0-9-]+

errors -> (list)

A list of errors for entries that failed validation, each containing the clientToken , error code , and message .

(structure)

An error for a billing adjustment request entry that failed validation.

code -> (string) [required]

The error code indicating the reason for failure.

Possible values:

• CONFLICT_EXCEPTION
• VALIDATION_EXCEPTION
• RESOURCE_NOT_FOUND_EXCEPTION
• INTERNAL_FAILURE

message -> (string) [required]

A human-readable message describing the error.

clientToken -> (string) [required]

The client token of the request entry that failed.

Constraints:

• min: 1
• max: 64
• pattern: [a-zA-Z0-9-]+