Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . marketplace-agreement ]

send-agreement-payment-request

Description

Allows sellers (proposers) to submit a payment request to buyers (acceptors) for a specific charge amount for an agreement that includes a VariablePaymentTerm . The payment request is created in PENDING_APPROVAL status, at which point the buyer can accept or reject it.

Note

The agreement must be active and have a VariablePaymentTerm to support payment requests. The chargeAmount must not exceed the remaining available balance under the VariablePaymentTerm maxTotalChargeAmount .

See also: AWS API Documentation

Synopsis

  send-agreement-payment-request
[--client-token <value>]
--agreement-id <value>
--term-id <value>
--name <value>
--charge-amount <value>
[--description <value>]
[--cli-input-json <value>]
[--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>]
[--v2-debug]

Options

--client-token (string)

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

--agreement-id (string)

The unique identifier of the agreement for which the payment request is being submitted. Use GetAgreementTerms to retrieve agreement term details.

--term-id (string)

The unique identifier of the VariablePaymentTerm for the agreement that the payment request is being sent for.

--name (string)

A descriptive name for the payment request (5-64 characters).

--charge-amount (string)

The amount requested to be charged to the buyer, positive decimal value in the currency of the accepted term.

Note

A ValidationException is returned if the chargeAmount exceeds the available balance, if the agreement doesn’t have an active VariablePaymentTerm , or if the termId is invalid.

--description (string)

An optional detailed description of the payment request (1-2000 characters).

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

paymentRequestId -> (string)

The unique identifier for the sent payment request.

agreementId -> (string)

The agreement identifier for this payment request.

status -> (string)

The current status of the payment request. The initial status is PENDING_APPROVAL .

name -> (string)

The descriptive name of the payment request.

description -> (string)

The detailed description of the payment request, if provided.

chargeAmount -> (string)

The amount being charged to the buyer.

currencyCode -> (string)

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

createdAt -> (timestamp)

The time when the payment request was created, in ISO 8601 format.