get-agreement-terms¶

Description¶

Obtains details about the terms in an agreement that you participated in as proposer or acceptor.

The details include:

TermType – The type of term, such as LegalTerm , RenewalTerm , or ConfigurableUpfrontPricingTerm .
TermID – The ID of the particular term, which is common between offer and agreement.
TermPayload – The key information contained in the term, such as the EULA for LegalTerm or pricing and dimensions for various pricing terms, such as ConfigurableUpfrontPricingTerm or UsageBasedPricingTerm .
Configuration – The buyer/acceptor’s selection at the time of agreement creation, such as the number of units purchased for a dimension or setting the EnableAutoRenew flag.

Synopsis¶

  get-agreement-terms
--agreement-id <value>
[--starting-token <value>]
[--page-size <value>]
[--max-items <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¶

--agreement-id (string) [required]

The unique identifier of the agreement.

Constraints:

min: 1

max: 64

pattern: [A-Za-z0-9_/-]+

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

min: 1

max: 50

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

acceptedTerms -> (list)

A subset of terms proposed by the proposer that have been accepted by the acceptor as part of the agreement creation.

(tagged union structure)

A subset of terms proposed by the proposer, which have been accepted by the acceptor as part of agreement creation.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: legalTerm, supportTerm, renewalTerm, usageBasedPricingTerm, configurableUpfrontPricingTerm, byolPricingTerm, recurringPaymentTerm, validityTerm, paymentScheduleTerm, freeTrialPricingTerm, fixedUpfrontPricingTerm, variablePaymentTerm, netPaymentTerm.

legalTerm -> (structure)

Defines the list of text agreements proposed to the acceptors. An example is the end user license agreement (EULA).

type -> (string)

Category of the term being updated.

Constraints:

min: 1

max: 4096

pattern: [A-Za-z]+

id -> (string)

The unique identifer for the term.

Constraints:

min: 1

max: 256

pattern: [A-Za-z0-9+=;,.@\-_]+

documents -> (list)

List of references to legal resources proposed to the buyers. An example is the EULA.

(structure)

Includes the list of references to legal resources proposed by the proposer to the acceptor. Each DocumentItem refers to an individual reference.

type -> (string)

Category of the document. Document types include:

CustomEula – A custom EULA provided by you as seller. A URL for a EULA stored in an accessible Amazon S3 bucket is required for this document type.

CustomDsa – A custom Data Subscription Agreement (DSA) provided by you as seller. A URL for a DSA stored in an accessible Amazon S3 bucket is required for this document type.

StandardEula – The Standard Contract for AWS Marketplace (SCMP). For more information about SCMP, see the AWS Marketplace Seller Guide. You don’t provide a URL for this type because it’s managed by AWS Marketplace.

StandardDsa – DSA for AWS Marketplace. For more information about the DSA, see the AWS Data Exchange User Guide. You don’t provide a URL for this type because it’s managed by AWS Marketplace.

Constraints:

min: 1

max: 4096

pattern: (.)+

url -> (string)

A URL to the legal document for buyers to read. Required when Type is CustomEula .

Constraints:

min: 1

max: 4096

pattern: (.)+

version -> (string)

Version of standard contracts provided by AWS Marketplace. Required when Type is StandardEula or StandardDsa .

Constraints:

min: 1

max: 4096

pattern: (.)+

supportTerm -> (structure)

Defines the customer support available for the acceptors when they purchase the software.

type -> (string)

Category of the term being updated.

Constraints:

min: 1

max: 4096

pattern: [A-Za-z]+

id -> (string)

The unique identifier for the term.

Constraints:

min: 1

max: 256

pattern: [A-Za-z0-9+=;,.@\-_]+

refundPolicy -> (string)

Free-text field about the refund policy description that will be shown to customers as is on the website and console.

Constraints:

min: 1

max: 4096

pattern: (.)+

renewalTerm -> (structure)

Defines that on graceful expiration of the agreement (when the agreement ends on its pre-defined end date), a new agreement will be created using the accepted terms on the existing agreement. In other words, the agreement will be renewed. Presence of RenewalTerm in the offer document means that auto-renewal is allowed. The acceptor will have the option to accept or decline auto-renewal at the offer acceptance/agreement creation. The acceptor can also change this flag from True to False or False to True , within the limits set by LockoutPeriod and MaxRenewals . Setting the flag to True doesn’t by itself guarantee that the agreement renews, because the proposer can also opt out.

type -> (string)

Category of the term being updated.

Constraints:

min: 1

max: 4096

pattern: [A-Za-z]+

id -> (string)

The unique identifier for the term.

Constraints:

min: 1

max: 256

pattern: [A-Za-z0-9+=;,.@\-_]+

configuration -> (structure)

Additional parameters specified by the acceptor while accepting the term.

enableAutoRenew -> (boolean) [required]

Defines whether the acceptor has chosen to auto-renew the agreement when it reaches its end date. Can be set to True or False . The acceptor can change this value within the limits set by LockoutPeriod and MaxRenewals .

lockoutPeriod -> (string)

The renewal decision deadline, measured back from the end date of the agreement. This is the last day either party can opt in to or opt out of the renewal. The duration is represented in the ISO 8601 format in whole days (for example, P30D for 30 days or P60D for 60 days).

The field is null when no renewal decision deadline is set. In that case, either party can change the auto-renewal decision up to the end date of the agreement.

Constraints:

min: 3

max: 9

pattern: P([1-9]\d{0,6}D)

maxRenewals -> (integer)

The maximum number of times the agreement can be renewed. The field is null when the number of renewals is unlimited.

After the agreement reaches this limit, it expires on its end date instead of renewing.

Constraints:

min: 1

adjustmentDeadline -> (string)

The date by which the proposer must finalize the price increase for the next renewal, measured back from the end date of the agreement. The duration is represented in the ISO 8601 format in whole days (for example, P30D for 30 days or P60D for 60 days).

This field applies only when PriceIncrease is a PercentageRange . The field is null when PriceIncrease is a FixedPercentage , because the price increase is already fixed and there is nothing for the proposer to finalize. If the proposer doesn’t finalize a value by the adjustment deadline, the DefaultValue of the range applies.

AdjustmentDeadline must be greater than LockoutPeriod .

Constraints:

min: 3

max: 9

pattern: P([1-9]\d{0,6}D)

priceIncrease -> (tagged union structure)

The price increase that is applied each time the agreement renews. The field is null when the price doesn’t change at renewal.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: fixedPercentage, percentageRange.

fixedPercentage -> (structure)

A fixed price increase percentage that is applied at each renewal.

value -> (string)

The percentage by which the price increases at each renewal, from 0.00 to 100.00 with up to two decimal places. A value of 0.00 means that the agreement renews at the same price.

Constraints:

min: 1

max: 6

pattern: (100(\.0{1,2})?|[1-9]\d?(\.\d{1,2})?|0(\.\d{1,2})?)

percentageRange -> (structure)

A range of price increase percentages that the proposer can choose from before the adjustment deadline of the agreement.

minValue -> (string)

The lowest percentage that the proposer can choose, from 0.00 to 100.00 with up to two decimal places.

Constraints:

min: 1

max: 6

pattern: (100(\.0{1,2})?|[1-9]\d?(\.\d{1,2})?|0(\.\d{1,2})?)

maxValue -> (string)

The highest percentage that the proposer can choose, from 0.00 to 100.00 with up to two decimal places.

Constraints:

min: 1

max: 6

pattern: (100(\.0{1,2})?|[1-9]\d?(\.\d{1,2})?|0(\.\d{1,2})?)

defaultValue -> (string)

The percentage that is applied if the proposer doesn’t choose a value before the adjustment deadline. Valid values range from 0.00 to 100.00 , with up to two decimal places.

Constraints:

min: 1

max: 6

pattern: (100(\.0{1,2})?|[1-9]\d?(\.\d{1,2})?|0(\.\d{1,2})?)

termTemplates -> (list)

Defines how specific terms change each time the agreement renews. The field is null when no terms change at renewal.

Constraints:

min: 1

max: 10

(tagged union structure)

Defines how a specific type of term changes each time the agreement renews. Exactly one of the following fields is set.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: paymentScheduleTermTemplate.

paymentScheduleTermTemplate -> (structure)

Defines the payment schedule that is applied to the renewed agreement.

schedule -> (list)

The installments that make up the payment schedule of the renewed agreement. The ChargePercentage values of all installments add up to 100 .

Constraints:

min: 1

max: 200

(structure)

A single installment in a payment schedule template. Because the start date of the renewed agreement isn’t known when the offer is created, the charge date of each installment is expressed as an offset from that start date rather than as an absolute date.

chargeDateOffset -> (string)

The time between the start date of the renewed agreement and the date this installment is charged. The duration is represented in the ISO 8601 format in either whole months or whole days (for example, P1M for 1 month or P30D for 30 days). All installments in a schedule use the same unit.

Constraints:

min: 3

max: 6

pattern: P(\d{1,4}M|\d{1,4}D)

chargePercentage -> (string)

The percentage of the total contract value of the renewed agreement that is charged in this installment. Valid values range from 0.01 to 100.00 , with up to two decimal places.

Constraints:

min: 1

max: 6

pattern: (100(\.0{1,2})?|[1-9]\d?(\.\d{1,2})?|0\.(0[1-9]|[1-9]\d?))

dayOfMonth -> (integer)

The day of the month on which this installment is charged, from 1 to 31 . Use this field to anchor the charge to a specific calendar day within the month identified by ChargeDateOffset . This field is supported only when ChargeDateOffset is expressed in months.

Constraints:

min: 1

max: 31

usageBasedPricingTerm -> (structure)

Defines a usage-based pricing model (typically, pay-as-you-go pricing), where the customers are charged based on product usage.

type -> (string)

Category of the term.

Constraints:

min: 1

max: 4096

pattern: [A-Za-z]+

id -> (string)

The unique identifier for the term.

Constraints:

min: 1

max: 256

pattern: [A-Za-z0-9+=;,.@\-_]+

currencyCode -> (string)

Defines the currency for the prices mentioned in the term.

Constraints:

min: 3

max: 3

pattern: [A-Z]+

rateCards -> (list)

List of rate cards.

(structure)

Within the pay-as-you-go model defined under UsageBasedPricingTerm , the UsageBasedRateCardItem defines an individual rate for a product dimension.

rateCard -> (list)

Defines the per unit rates for product dimensions.

(structure)

Defines the per unit rates for each individual product dimension.

dimensionKey -> (string)

Dimension for which the given entitlement applies. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.

Constraints:

min: 1

max: 4096

pattern: (.)+

price -> (string)

Per unit price for the product dimension that’s used for calculating the amount to be charged.

Constraints:

min: 1

max: 4096

pattern: (.)+

configurableUpfrontPricingTerm -> (structure)

Defines a prepaid payment model that allows buyers to configure the entitlements they want to purchase and the duration.

type -> (string)

Category of selector.

Constraints:

min: 1

max: 4096

pattern: [A-Za-z]+

id -> (string)

The unique identifier of the term.

Constraints:

min: 1

max: 256

pattern: [A-Za-z0-9+=;,.@\-_]+

currencyCode -> (string)

Defines the currency for the prices mentioned in the term.

Constraints:

min: 3

max: 3

pattern: [A-Z]+

rateCards -> (list)

A rate card defines the per unit rates for product dimensions.

(structure)

Within the prepaid payment model defined under ConfigurableUpfrontPricingTerm , the RateCardItem defines all the various rate cards (including pricing and dimensions) that have been proposed.

selector -> (structure)

Differentiates between the mutually exclusive rate cards in the same pricing term to be selected by the buyer.

type -> (string)

Category of selector.

Constraints:

min: 1

max: 4096

pattern: (.)+

value -> (string)

Contract duration. This field supports the ISO 8601 format.

Constraints:

min: 1

max: 4096

pattern: (.)+

constraints -> (structure)

Defines limits on how the term can be configured by acceptors.

multipleDimensionSelection -> (string)

Determines if buyers are allowed to select multiple dimensions in the rate card. The possible values are Allowed and Disallowed . The default value is Allowed .

Constraints:

min: 1

max: 4096

pattern: (.)+

quantityConfiguration -> (string)

Determines if acceptors are allowed to configure quantity for each dimension in rate card. The possible values are Allowed and Disallowed . The default value is Allowed .

Constraints:

min: 1

max: 4096

pattern: (.)+

rateCard -> (list)

Defines the per unit rates for product dimensions.

(structure)

Defines the per unit rates for each individual product dimension.

dimensionKey -> (string)

Dimension for which the given entitlement applies. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.

Constraints:

min: 1

max: 4096

pattern: (.)+

price -> (string)

Per unit price for the product dimension that’s used for calculating the amount to be charged.

Constraints:

min: 1

max: 4096

pattern: (.)+

configuration -> (structure)

Additional parameters specified by the acceptor while accepting the term.

selectorValue -> (string) [required]

Defines the length of time for which the particular pricing/dimension is being purchased by the acceptor.

Constraints:

min: 1

max: 4096

pattern: (.)+

dimensions -> (list) [required]

Defines the dimensions that the acceptor has purchased from the overall set of dimensions presented in the rate card.

Constraints:

min: 1

(structure)

Defines the dimensions that the acceptor has purchased from the overall set of dimensions presented in the rate card.

dimensionKey -> (string) [required]

The name of key value of the dimension.

Constraints:

min: 1

max: 4096

pattern: (.)+

dimensionValue -> (integer) [required]

The number of units of the dimension the acceptor has purchased.

Note
For Agreements with ConfigurableUpfrontPricingTerm , the RateCard section will define the prices and dimensions defined by the seller (proposer), whereas the Configuration section will define the actual dimensions, prices, and units the buyer has chosen to accept.

Constraints:

min: 0

byolPricingTerm -> (structure)

Enables you and your customers to move your existing agreements to AWS Marketplace. The customer won’t be charged for product usage in AWS Marketplace because they already paid for the product outside of AWS Marketplace.

type -> (string)

Type of the term being updated.

Constraints:

min: 1

max: 4096

pattern: [A-Za-z]+

id -> (string)

The unique identifier for the term.

Constraints:

min: 1

max: 256

pattern: [A-Za-z0-9+=;,.@\-_]+

recurringPaymentTerm -> (structure)

Defines a pricing model where customers are charged a fixed recurring price at the end of each billing period.

type -> (string)

Type of the term being updated.

Constraints:

min: 1

max: 4096

pattern: [A-Za-z]+

id -> (string)

The unique identifier for the term.

Constraints:

min: 1

max: 256

pattern: [A-Za-z0-9+=;,.@\-_]+

currencyCode -> (string)

Defines the currency for the prices mentioned in this term.

Constraints:

min: 3

max: 3

pattern: [A-Z]+

billingPeriod -> (string)

Defines the recurrence at which buyers are charged.

Constraints:

min: 1

max: 4096

pattern: (.)+

price -> (string)

Amount charged to the buyer every billing period.

Constraints:

min: 1

max: 4096

pattern: (.)+

validityTerm -> (structure)

Defines the conditions that will keep an agreement created from this offer valid.

type -> (string)

Category of the term being updated.

Constraints:

min: 1

max: 4096

pattern: [A-Za-z]+

id -> (string)

The unique identifier for the term.

Constraints:

min: 1

max: 256

pattern: [A-Za-z0-9+=;,.@\-_]+

agreementDuration -> (string)

Defines the duration that the agreement remains active. If AgreementStartDate isn’t provided, the agreement duration is relative to the agreement signature time. The duration is represented in the ISO_8601 format.

Constraints:

min: 1

max: 4096

pattern: (.)+

agreementStartDate -> (timestamp)

Defines the date when agreement starts. The agreement starts at 00:00:00.000 UTC on the date provided. If AgreementStartDate isn’t provided, the agreement start date is determined based on agreement signature time.

agreementEndDate -> (timestamp)

Defines the date when the agreement ends. The agreement ends at 23:59:59.999 UTC on the date provided. If AgreementEndDate isn’t provided, the agreement end date is determined by the validity of individual terms.

paymentScheduleTerm -> (structure)

Defines an installment-based pricing model where customers are charged a fixed price on different dates during the agreement validity period. This is used most commonly for flexible payment schedule pricing.

type -> (string)

Type of the term.

Constraints:

min: 1

max: 4096

pattern: [A-Za-z]+

id -> (string)

The unique identifier for the term.

Constraints:

min: 1

max: 256

pattern: [A-Za-z0-9+=;,.@\-_]+

currencyCode -> (string)

Defines the currency for the prices mentioned in the term.

Constraints:

min: 3

max: 3

pattern: [A-Z]+

schedule -> (list)

List of the payment schedule where each element defines one installment of payment. It contains the information necessary for calculating the price.

(structure)

An individual installment of the payment that includes the date and amount of the charge.

chargeDate -> (timestamp)

The date that the customer would pay the price defined in this payment schedule term. Invoices are generated on the date provided.

chargeAmount -> (string)

The price that the customer would pay on the scheduled date (chargeDate).

Constraints:

min: 1

max: 4096

pattern: (.)+

freeTrialPricingTerm -> (structure)

Defines a short-term free pricing model where the buyers aren’t charged anything within a specified limit.

type -> (string)

Category of the term.

Constraints:

min: 1

max: 4096

pattern: [A-Za-z]+

id -> (string)

The unique identifier for the terms.

Constraints:

min: 1

max: 256

pattern: [A-Za-z0-9+=;,.@\-_]+

duration -> (string)

Duration of the free trial period (5–31 days).

Constraints:

min: 1

max: 4096

pattern: (.)+

grants -> (list)

Entitlements granted to the acceptor of a free trial as part of an agreement execution.

(structure)

Entitlements granted to the acceptor of fixed upfront as part of agreement execution.

dimensionKey -> (string)

Unique dimension key defined in the product document. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.

Constraints:

min: 1

max: 4096

pattern: (.)+

maxQuantity -> (integer)

Maximum amount of capacity that the buyer can be entitled to the given dimension of the product. If MaxQuantity is not provided, the buyer will be able to use an unlimited amount of the given dimension.

Constraints:

min: 1

fixedUpfrontPricingTerm -> (structure)

Defines a pre-paid pricing model where the customers are charged a fixed upfront amount.

type -> (string)

Category of the term being updated.

Constraints:

min: 1

max: 4096

pattern: [A-Za-z]+

id -> (string)

The unique identifier for the term.

Constraints:

min: 1

max: 256

pattern: [A-Za-z0-9+=;,.@\-_]+

currencyCode -> (string)

Defines the currency for the prices mentioned in this term.

Constraints:

min: 3

max: 3

pattern: [A-Z]+

duration -> (string)

Contract duration for the terms.

Constraints:

min: 1

max: 4096

pattern: (.)+

price -> (string)

Fixed amount to be charged to the customer when this term is accepted.

Constraints:

min: 1

max: 4096

pattern: (.)+

grants -> (list)

Entitlements granted to the acceptor of fixed upfront as part of agreement execution.

(structure)

Entitlements granted to the acceptor of fixed upfront as part of agreement execution.

dimensionKey -> (string)

Unique dimension key defined in the product document. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.

Constraints:

min: 1

max: 4096

pattern: (.)+

maxQuantity -> (integer)

Maximum amount of capacity that the buyer can be entitled to the given dimension of the product. If MaxQuantity is not provided, the buyer will be able to use an unlimited amount of the given dimension.

Constraints:

min: 1

variablePaymentTerm -> (structure)

Defines a payment model where sellers can submit variable payment requests up to a maximum charge amount, with configurable approval strategies and expiration timelines.

type -> (string)

Type of the term.

Constraints:

min: 1

max: 4096

pattern: [A-Za-z]+

id -> (string)

The unique identifier for the term.

Constraints:

min: 1

max: 256

pattern: [A-Za-z0-9+=;,.@\-_]+

currencyCode -> (string)

Defines the currency for the prices mentioned in the term.

Constraints:

min: 3

max: 3

pattern: [A-Z]+

maxTotalChargeAmount -> (string)

The maximum total amount that can be charged to the customer through variable payment requests under this term.

Constraints:

min: 1

max: 4096

pattern: (.)+

configuration -> (structure)

Additional parameters specified by the acceptor while accepting the term.

paymentRequestApprovalStrategy -> (string) [required]

Defines the strategy for approving payment requests. Values include AUTO_APPROVE_ON_EXPIRATION and WAIT_FOR_APPROVAL

Possible values:

AUTO_APPROVE_ON_EXPIRATION

WAIT_FOR_APPROVAL

expirationDuration -> (string)

Defines the duration after which a payment request is automatically approved if no further action is taken. This only applies when the payment request approval strategy is set to AUTO_APPROVE_ON_EXPIRATION . The duration is represented in the ISO_8601 format (e.g., P10D for 10 days).

Constraints:

pattern: ([-+]?)P(?:([-+]?[0-9]+)D)?(T(?:([-+]?[0-9]+)H)?(?:([-+]?[0-9]+)M)?(?:([-+]?[0-9]+)(?:[.,]([0-9]{0,9}))?S)?)?

netPaymentTerm -> (structure)

Defines the net payment due period for the agreement, specifying when payment is due after an invoice is issued.

type -> (string)

Type of the term being updated.

Constraints:

min: 1

max: 4096

pattern: [A-Za-z]+

id -> (string)

The unique identifier for the term.

Constraints:

min: 1

max: 256

pattern: [A-Za-z0-9+=;,.@\-_]+

paymentDuePeriod -> (string)

The duration after an invoice is issued within which the payment is due. The duration is represented in the ISO 8601 format (for example, P30D for 30 days or P60D for 60 days).

Constraints:

min: 1

max: 4096

pattern: (.)+

nextToken -> (string)

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

Constraints:

min: 0

max: 8192

pattern: [a-zA-Z0-9+/=_-]+

Table of Contents

Feedback

User Guide

get-agreement-terms¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶

Note

Note

Note

Note