2026/05/05 - AWS Marketplace Agreement Service - 10 new 1 updated api methods
Changes With this release, Agreements API provides a programmatic way to generate quotes, accept offers, track charges and entitlements, manage renewals and cancellations, and streamline operations entirely through APIs without navigating to the AWS Marketplace website or AWS Management Console.
Allows acceptors to view charges and purchase orders that are associated with an agreement. The response includes details about all charges regardless of whether a purchase order is linked to each charge.
See also: AWS API Documentation
Request Syntax
client.list_agreement_charges(
catalog='string',
agreementId='string',
agreementType='string',
maxResults=123,
nextToken='string'
)
string
The catalog in which the charges were created.
string
The unique identifier of the agreement.
string
Filter to retrieve charges of a specific agreement type (for example, PurchaseAgreement).
integer
The maximum number of charges to return in the response.
string
A token to specify where to start pagination.
dict
Response Syntax
{
'items': [
{
'id': 'string',
'revision': 123,
'agreementId': 'string',
'agreementType': 'string',
'purchaseOrderReference': 'string',
'currencyCode': 'string',
'amount': 'string',
'time': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
A list of agreement charges.
(dict) --
Represents a charge associated with an agreement, including amount, timing, and purchase order details.
id (string) --
The unique identifier of the charge.
revision (integer) --
The revision number of the charge.
agreementId (string) --
The unique identifier of the agreement that resulted in this charge.
agreementType (string) --
The type of agreement that resulted in this charge (for example, PurchaseAgreement).
purchaseOrderReference (string) --
The purchase order reference associated with the charge, if any.
currencyCode (string) --
The currency code for the charge amount.
amount (string) --
The amount of the charge.
time (datetime) --
The date and time when the charge will be incurred. This is available only when the charge date is known.
nextToken (string) --
The token used for pagination. The field is null if there are no more results.
Allows buyers (acceptors) to accept a payment request that is in PENDING_APPROVAL status. Once accepted, the payment request transitions to APPROVED status and the charge will be processed. Buyers can optionally provide a purchase order reference for their internal tracking.
See also: AWS API Documentation
Request Syntax
client.accept_agreement_payment_request(
paymentRequestId='string',
agreementId='string',
purchaseOrderReference='string'
)
string
[REQUIRED]
The unique identifier of the payment request to accept.
string
[REQUIRED]
The unique identifier of the agreement associated with the payment request.
string
An optional purchase order reference that buyers can provide to associate the payment request with their internal purchase order system.
dict
Response Syntax
{
'paymentRequestId': 'string',
'agreementId': 'string',
'status': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'CANCELLED',
'name': 'string',
'description': 'string',
'chargeAmount': 'string',
'currencyCode': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
paymentRequestId (string) --
The unique identifier of the accepted payment request.
agreementId (string) --
The unique identifier of the agreement associated with this payment request.
status (string) --
The updated status of the payment request, which is APPROVED.
name (string) --
The descriptive name of the payment request.
description (string) --
The detailed description of the payment request, if provided.
chargeAmount (string) --
The amount that was approved to be charged.
currencyCode (string) --
The currency code for the charge amount.
createdAt (datetime) --
The date and time when the payment request was originally created.
updatedAt (datetime) --
The date and time when the payment request was accepted.
Creates an agreement request that acts as a quote for the terms you want to accept. The agreement request captures the requested terms, calculates charges, and returns a summary. Use AcceptAgreementRequest with the returned agreementRequestId to finalize the agreement.
See also: AWS API Documentation
Request Syntax
client.create_agreement_request(
clientToken='string',
intent='NEW'|'AMEND'|'REPLACE',
requestedTerms=[
{
'id': 'string',
'configuration': {
'configurableUpfrontPricingTermConfiguration': {
'selectorValue': 'string',
'dimensions': [
{
'dimensionKey': 'string',
'dimensionValue': 123
},
]
},
'renewalTermConfiguration': {
'enableAutoRenew': True|False
},
'variablePaymentTermConfiguration': {
'paymentRequestApprovalStrategy': 'AUTO_APPROVE_ON_EXPIRATION'|'WAIT_FOR_APPROVAL',
'expirationDuration': 'string'
}
}
},
],
sourceAgreementIdentifier='string',
agreementProposalIdentifier='string',
taxConfiguration={
'taxEstimation': 'DISABLED'|'ENABLED'
}
)
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
The purpose and desired outcome of the agreement request. This is a required parameter that determines how the agreement request is processed.
NEW – Creates a new agreement for terms in the request.
AMEND – Modifies an existing agreement with terms that are accepted in the request.
REPLACE – Creates a new agreement with accepted terms and replaces the existing agreement.
list
[REQUIRED]
A list of terms that define what is being accepted as part of the agreement. Some terms require configuration.
(dict) --
Defines what is being accepted as part of the agreement creation or update request, and it includes their configurations.
id (string) -- [REQUIRED]
The unique identifier of the term in the agreement proposal.
configuration (dict) --
Additional configuration for the requested terms. This configuration is applicable only to the terms that accept a customer-provided configuration, such as ConfigurableUpfrontPricingTerm.
configurableUpfrontPricingTermConfiguration (dict) --
Defines a prepaid payment model that allows buyers to configure the entitlements they want to purchase and the duration.
selectorValue (string) -- [REQUIRED]
Defines the length of time for which the particular pricing/dimension is being purchased by the acceptor.
dimensions (list) -- [REQUIRED]
Defines the dimensions that the acceptor has purchased from the overall set of dimensions presented in the rate card.
(dict) --
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.
dimensionValue (integer) -- [REQUIRED]
The number of units of the dimension the acceptor has purchased.
renewalTermConfiguration (dict) --
Additional parameters specified by the acceptor while accepting the term.
enableAutoRenew (boolean) -- [REQUIRED]
Defines whether the acceptor has chosen to auto-renew the agreement at the end of its lifecycle. Can be set to True or False.
variablePaymentTermConfiguration (dict) --
Additional parameters specified by the acceptor while accepting the variable payment term.
paymentRequestApprovalStrategy (string) -- [REQUIRED]
Defines the strategy for approving payment requests. Values include AUTO_APPROVE_ON_EXPIRATION and 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).
string
The agreement's identifier that the request acts upon.
string
The agreement proposal signed by the proposer. The proposal includes the requested resources and the terms that outline an agreement outcome.
dict
Configuration for tax estimation in the agreement request response.
taxEstimation (string) --
Toggle to estimate tax as part of the response. Values include ENABLED and DISABLED. Default is DISABLED.
dict
Response Syntax
{
'agreementRequestId': 'string',
'chargeSummary': {
'currencyCode': 'string',
'newAgreementValue': 'string',
'newAgreementValueAfterTax': 'string',
'expectedCharges': [
{
'id': 'string',
'time': datetime(2015, 1, 1),
'amount': 'string',
'amountAfterTax': 'string',
'timing': 'ON_ACCEPTANCE'|'SCHEDULED'|'BILLING_PERIOD',
'estimatedTaxes': {
'breakdown': [
{
'amount': 'string',
'rate': 'string',
'type': 'string'
},
],
'totalAmount': 'string'
}
},
],
'estimatedTaxes': {
'breakdown': [
{
'amount': 'string',
'rate': 'string',
'type': 'string'
},
],
'totalAmount': 'string'
},
'itemizedCharges': [
{
'dimensionKey': 'string',
'newQuantity': 123,
'oldQuantity': 123,
'chargeReference': 'string',
'incrementalChargeAmount': 'string'
},
],
'invoicingEntity': {
'legalName': 'string',
'branchName': 'string'
}
}
}
Response Structure
(dict) --
agreementRequestId (string) --
The unique identifier of the agreement request created. Use this identifier with AcceptAgreementRequest to accept the agreement.
chargeSummary (dict) --
Provides details of the charges associated with the agreement request. This is only applicable when a request is created for PurchaseAgreement.
currencyCode (string) --
The three-letter currency code for all charges (e.g., USD).
newAgreementValue (string) --
The total value of the agreement, which includes any amendments.
newAgreementValueAfterTax (string) --
Expected new agreement value after estimated taxes are applied.
expectedCharges (list) --
A list of expected charges for the agreement request.
(dict) --
Estimated charge for the request.
id (string) --
Unique identifier of the charge for a given agreement.
time (datetime) --
The date and time when the charge is due to be invoiced. This is available only when the charge date is known.
amount (string) --
The tax-exclusive amount of the charge. Only available when the charge amount is known.
amountAfterTax (string) --
The tax-inclusive amount the acceptor has to pay. The amount is only present for fixed charges.
timing (string) --
Indicates when the charge amount will be incurred. Values include ON_ACCEPTANCE (charged immediately when the agreement request is accepted), BILLING_PERIOD (charged on each billing period), and SCHEDULED (charged at a predetermined future date).
estimatedTaxes (dict) --
Provides an aggregated view of estimated tax information for this specific charge.
breakdown (list) --
A list of tax breakdown information.
(dict) --
Represents a single tax breakdown entry with amount, rate, and type.
amount (string) --
The estimated tax amount.
rate (string) --
The tax rate, in decimals.
type (string) --
The type of tax (for example, VAT, ST, or GST).
totalAmount (string) --
The total amount of tax aggregated from the tax breakdown.
estimatedTaxes (dict) --
Provides an aggregated view of estimated tax information for the agreement.
breakdown (list) --
A list of tax breakdown information.
(dict) --
Represents a single tax breakdown entry with amount, rate, and type.
amount (string) --
The estimated tax amount.
rate (string) --
The tax rate, in decimals.
type (string) --
The type of tax (for example, VAT, ST, or GST).
totalAmount (string) --
The total amount of tax aggregated from the tax breakdown.
itemizedCharges (list) --
An itemized list of charges for the agreement request.
(dict) --
A breakdown of individual charges or line items within a billing or pricing context.
dimensionKey (string) --
The dimension key as specified in the accepted term.
newQuantity (integer) --
The requested quantity for this dimension.
oldQuantity (integer) --
The existing quantity for this dimension from the source agreement. This value is 0 for NEW intent.
chargeReference (string) --
The identifier of the expected charge that this itemized charge contributes to.
incrementalChargeAmount (string) --
The total incremental charge amount for this dimension.
invoicingEntity (dict) --
The entity responsible for issuing the invoice.
legalName (string) --
Legal name of the entity issuing the invoice.
branchName (string) --
The branch where the issuing entity is operating from.
Allows buyers (acceptors) to reject a cancellation request that is in PENDING_APPROVAL status. Once rejected, the cancellation request transitions to REJECTED status and the agreement remains active. Buyers must provide a reason for the rejection.
See also: AWS API Documentation
Request Syntax
client.reject_agreement_cancellation_request(
agreementId='string',
agreementCancellationRequestId='string',
rejectionReason='string'
)
string
[REQUIRED]
The unique identifier of the agreement associated with the cancellation request.
string
[REQUIRED]
The unique identifier of the cancellation request to reject.
string
[REQUIRED]
The reason for rejecting the cancellation request (1-2000 characters). This message is visible to the seller.
dict
Response Syntax
{
'agreementId': 'string',
'agreementCancellationRequestId': 'string',
'status': 'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'CANCELLED'|'VALIDATION_FAILED',
'statusMessage': 'string',
'reasonCode': 'INCORRECT_TERMS_ACCEPTED'|'REPLACING_AGREEMENT'|'TEST_AGREEMENT'|'ALTERNATIVE_PROCUREMENT_CHANNEL'|'PRODUCT_DISCONTINUED'|'UNINTENDED_RENEWAL'|'BUYER_DISSATISFACTION'|'OTHER',
'description': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
agreementId (string) --
The unique identifier of the agreement associated with this cancellation request.
agreementCancellationRequestId (string) --
The unique identifier of the rejected cancellation request.
status (string) --
The updated status of the cancellation request, which is REJECTED.
statusMessage (string) --
The rejection reason provided by the buyer.
reasonCode (string) --
The original reason code provided when the cancellation request was created.
description (string) --
The detailed description of the cancellation reason, if provided.
createdAt (datetime) --
The date and time when the cancellation request was originally created.
updatedAt (datetime) --
The date and time when the cancellation request was rejected.
Allows buyers (acceptors) to accept a cancellation request that is in PENDING_APPROVAL status. Once accepted, the cancellation request transitions to APPROVED status and the agreement cancellation will be processed.
See also: AWS API Documentation
Request Syntax
client.accept_agreement_cancellation_request(
agreementId='string',
agreementCancellationRequestId='string'
)
string
[REQUIRED]
The unique identifier of the agreement associated with the cancellation request.
string
[REQUIRED]
The unique identifier of the cancellation request to accept.
dict
Response Syntax
{
'agreementId': 'string',
'agreementCancellationRequestId': 'string',
'status': 'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'CANCELLED'|'VALIDATION_FAILED',
'reasonCode': 'INCORRECT_TERMS_ACCEPTED'|'REPLACING_AGREEMENT'|'TEST_AGREEMENT'|'ALTERNATIVE_PROCUREMENT_CHANNEL'|'PRODUCT_DISCONTINUED'|'UNINTENDED_RENEWAL'|'BUYER_DISSATISFACTION'|'OTHER',
'description': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
agreementId (string) --
The unique identifier of the agreement associated with this cancellation request.
agreementCancellationRequestId (string) --
The unique identifier of the accepted cancellation request.
status (string) --
The updated status of the cancellation request, which is APPROVED.
reasonCode (string) --
The original reason code provided when the cancellation request was created.
description (string) --
The detailed description of the cancellation reason, if provided.
createdAt (datetime) --
The date and time when the cancellation request was originally created.
updatedAt (datetime) --
The date and time when the cancellation request was accepted.
Allows an acceptor to cancel an active agreement. Not all agreements are eligible for cancellation. Use the error response to determine why a cancellation request was rejected.
See also: AWS API Documentation
Request Syntax
client.cancel_agreement(
agreementId='string'
)
string
[REQUIRED]
The unique identifier of the agreement.
dict
Response Syntax
{}
Response Structure
(dict) --
Accepts an agreement request to finalize the agreement. The acceptor can optionally provide purchase orders to associate with the agreement charges.
See also: AWS API Documentation
Request Syntax
client.accept_agreement_request(
agreementRequestId='string',
purchaseOrders=[
{
'chargeId': 'string',
'chargeRevision': 123,
'agreementId': 'string',
'purchaseOrderReference': 'string'
},
]
)
string
[REQUIRED]
The unique identifier of the agreement request.
list
A list of purchase orders associated with accepting a marketplace agreement request.
(dict) --
Contains information about a purchase order association to a charge within an agreement.
chargeId (string) -- [REQUIRED]
The unique identifier of the charge to associate the purchase order with.
chargeRevision (integer) --
The revision of the charge.
agreementId (string) --
The unique identifier of the agreement associated with this charge.
purchaseOrderReference (string) --
The purchase order reference to associate with the charge.
dict
Response Syntax
{
'agreementId': 'string'
}
Response Structure
(dict) --
agreementId (string) --
The unique identifier of the agreement created or modified by accepting the agreement request.
Allows acceptors to associate purchase orders with agreement charges after an agreement is created.
See also: AWS API Documentation
Request Syntax
client.update_purchase_orders(
purchaseOrders=[
{
'chargeId': 'string',
'chargeRevision': 123,
'agreementId': 'string',
'purchaseOrderReference': 'string'
},
]
)
list
[REQUIRED]
Contains information about purchase order associations.
(dict) --
Contains information about a purchase order association to a charge within an agreement.
chargeId (string) -- [REQUIRED]
The unique identifier of the charge to associate the purchase order with.
chargeRevision (integer) --
The revision of the charge.
agreementId (string) --
The unique identifier of the agreement associated with this charge.
purchaseOrderReference (string) --
The purchase order reference to associate with the charge.
dict
Response Syntax
{}
Response Structure
(dict) --
Allows buyers (acceptors) to reject a payment request that is in PENDING_APPROVAL status. Once rejected, the payment request transitions to REJECTED status and cannot be accepted. Buyers can optionally provide a reason for the rejection.
See also: AWS API Documentation
Request Syntax
client.reject_agreement_payment_request(
paymentRequestId='string',
agreementId='string',
rejectionReason='string'
)
string
[REQUIRED]
The unique identifier of the payment request to reject.
string
[REQUIRED]
The unique identifier of the agreement associated with the payment request.
string
An optional reason for rejecting the payment request (1-250 characters). This message is visible to the seller.
dict
Response Syntax
{
'paymentRequestId': 'string',
'agreementId': 'string',
'status': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'CANCELLED',
'statusMessage': 'string',
'name': 'string',
'description': 'string',
'chargeAmount': 'string',
'currencyCode': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
paymentRequestId (string) --
The unique identifier of the rejected payment request.
agreementId (string) --
The unique identifier of the agreement associated with this payment request.
status (string) --
The updated status of the payment request, which is REJECTED.
statusMessage (string) --
The rejection reason provided by the buyer, if any.
name (string) --
The descriptive name of the payment request.
description (string) --
The detailed description of the payment request, if provided.
chargeAmount (string) --
The amount that was requested to be charged.
currencyCode (string) --
The currency code for the charge amount.
createdAt (datetime) --
The date and time when the payment request was originally created.
updatedAt (datetime) --
The date and time when the payment request was rejected.
Obtains details about the entitlements of an agreement.
See also: AWS API Documentation
Request Syntax
client.get_agreement_entitlements(
agreementId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The unique identifier of the agreement.
integer
The maximum number of agreement entitlements to return in the response.
string
A token to specify where to start pagination.
dict
Response Syntax
{
'agreementEntitlements': [
{
'resource': {
'id': 'string',
'type': 'string'
},
'type': 'string',
'registrationToken': 'string',
'status': 'PROVISIONED'|'SCHEDULED'|'PENDING'|'FAILED'|'DEPROVISIONED',
'statusReasonCode': 'PROVISIONING_IN_PROGRESS'|'FUTURE_START_DATE'|'INVALID_PAYMENT_INSTRUMENT'|'INCOMPATIBLE_CURRENCY'|'ACCOUNT_SUSPENDED'|'UNSUPPORTED_OPERATION'|'AGREEMENT_INACTIVE'|'AGREEMENT_ACTIVE'|'PRODUCT_RESTRICTED',
'licenseArn': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
agreementEntitlements (list) --
A list of agreement entitlements which are part of the latest agreement.
(dict) --
Represents an entitlement associated with an agreement, including the provisioning status, resource, and type.
resource (dict) --
The resource that the entitlement is provisioned to, such as a product.
id (string) --
The unique identifier of the resource.
type (string) --
Type of the resource, which is the product (for example, SaaSProduct, AmiProduct, ContainerProduct).
type (string) --
The type of entitlement.
registrationToken (string) --
A short-lived token required by acceptors to register their account with the product provider. The token is only valid for 30 minutes after creation and is only applicable for purchase agreements.
status (string) --
The current state of an entitlement.
statusReasonCode (string) --
Provides more information about the status of an entitlement.
licenseArn (string) --
The Amazon Resource Name (ARN) of the AWS License Manager license associated with the entitlement.
nextToken (string) --
The token used for pagination. The field is null if there are no more results.
{'acceptedTerms': {'byolPricingTerm': {'id': 'string'},
'configurableUpfrontPricingTerm': {'id': 'string'},
'fixedUpfrontPricingTerm': {'id': 'string'},
'freeTrialPricingTerm': {'id': 'string'},
'legalTerm': {'id': 'string'},
'paymentScheduleTerm': {'id': 'string'},
'recurringPaymentTerm': {'id': 'string'},
'renewalTerm': {'id': 'string'},
'supportTerm': {'id': 'string'},
'usageBasedPricingTerm': {'id': 'string'},
'validityTerm': {'id': 'string'},
'variablePaymentTerm': {'id': 'string'}}}
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.
See also: AWS API Documentation
Request Syntax
client.get_agreement_terms(
agreementId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The unique identifier of the agreement.
integer
The maximum number of agreements to return in the response.
string
A token to specify where to start pagination.
dict
Response Syntax
{
'acceptedTerms': [
{
'legalTerm': {
'type': 'string',
'id': 'string',
'documents': [
{
'type': 'string',
'url': 'string',
'version': 'string'
},
]
},
'supportTerm': {
'type': 'string',
'id': 'string',
'refundPolicy': 'string'
},
'renewalTerm': {
'type': 'string',
'id': 'string',
'configuration': {
'enableAutoRenew': True|False
}
},
'usageBasedPricingTerm': {
'type': 'string',
'id': 'string',
'currencyCode': 'string',
'rateCards': [
{
'rateCard': [
{
'dimensionKey': 'string',
'price': 'string'
},
]
},
]
},
'configurableUpfrontPricingTerm': {
'type': 'string',
'id': 'string',
'currencyCode': 'string',
'rateCards': [
{
'selector': {
'type': 'string',
'value': 'string'
},
'constraints': {
'multipleDimensionSelection': 'string',
'quantityConfiguration': 'string'
},
'rateCard': [
{
'dimensionKey': 'string',
'price': 'string'
},
]
},
],
'configuration': {
'selectorValue': 'string',
'dimensions': [
{
'dimensionKey': 'string',
'dimensionValue': 123
},
]
}
},
'byolPricingTerm': {
'type': 'string',
'id': 'string'
},
'recurringPaymentTerm': {
'type': 'string',
'id': 'string',
'currencyCode': 'string',
'billingPeriod': 'string',
'price': 'string'
},
'validityTerm': {
'type': 'string',
'id': 'string',
'agreementDuration': 'string',
'agreementStartDate': datetime(2015, 1, 1),
'agreementEndDate': datetime(2015, 1, 1)
},
'paymentScheduleTerm': {
'type': 'string',
'id': 'string',
'currencyCode': 'string',
'schedule': [
{
'chargeDate': datetime(2015, 1, 1),
'chargeAmount': 'string'
},
]
},
'freeTrialPricingTerm': {
'type': 'string',
'id': 'string',
'duration': 'string',
'grants': [
{
'dimensionKey': 'string',
'maxQuantity': 123
},
]
},
'fixedUpfrontPricingTerm': {
'type': 'string',
'id': 'string',
'currencyCode': 'string',
'duration': 'string',
'price': 'string',
'grants': [
{
'dimensionKey': 'string',
'maxQuantity': 123
},
]
},
'variablePaymentTerm': {
'type': 'string',
'id': 'string',
'currencyCode': 'string',
'maxTotalChargeAmount': 'string',
'configuration': {
'paymentRequestApprovalStrategy': 'AUTO_APPROVE_ON_EXPIRATION'|'WAIT_FOR_APPROVAL',
'expirationDuration': 'string'
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
acceptedTerms (list) --
A subset of terms proposed by the proposer that have been accepted by the acceptor as part of the agreement creation.
(dict) --
A subset of terms proposed by the proposer, which have been accepted by the acceptor as part of agreement creation.
legalTerm (dict) --
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.
id (string) --
The unique identifer for the term.
documents (list) --
List of references to legal resources proposed to the buyers. An example is the EULA.
(dict) --
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.
url (string) --
A URL to the legal document for buyers to read. Required when Type is CustomEula.
version (string) --
Version of standard contracts provided by AWS Marketplace. Required when Type is StandardEula or StandardDsa.
supportTerm (dict) --
Defines the customer support available for the acceptors when they purchase the software.
type (string) --
Category of the term being updated.
id (string) --
The unique identifier for the term.
refundPolicy (string) --
Free-text field about the refund policy description that will be shown to customers as is on the website and console.
renewalTerm (dict) --
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. Buyers will have the option to accept or decline auto-renewal at the offer acceptance/agreement creation. Buyers can also change this flag from True to False or False to True at anytime during the agreement's lifecycle.
type (string) --
Category of the term being updated.
id (string) --
The unique identifier for the term.
configuration (dict) --
Additional parameters specified by the acceptor while accepting the term.
enableAutoRenew (boolean) --
Defines whether the acceptor has chosen to auto-renew the agreement at the end of its lifecycle. Can be set to True or False.
usageBasedPricingTerm (dict) --
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.
id (string) --
The unique identifier for the term.
currencyCode (string) --
Defines the currency for the prices mentioned in the term.
rateCards (list) --
List of rate cards.
(dict) --
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.
(dict) --
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.
price (string) --
Per unit price for the product dimension that’s used for calculating the amount to be charged.
configurableUpfrontPricingTerm (dict) --
Defines a prepaid payment model that allows buyers to configure the entitlements they want to purchase and the duration.
type (string) --
Category of selector.
id (string) --
The unique identifier of the term.
currencyCode (string) --
Defines the currency for the prices mentioned in the term.
rateCards (list) --
A rate card defines the per unit rates for product dimensions.
(dict) --
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 (dict) --
Differentiates between the mutually exclusive rate cards in the same pricing term to be selected by the buyer.
type (string) --
Category of selector.
value (string) --
Contract duration. This field supports the ISO 8601 format.
constraints (dict) --
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.
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.
rateCard (list) --
Defines the per unit rates for product dimensions.
(dict) --
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.
price (string) --
Per unit price for the product dimension that’s used for calculating the amount to be charged.
configuration (dict) --
Additional parameters specified by the acceptor while accepting the term.
selectorValue (string) --
Defines the length of time for which the particular pricing/dimension is being purchased by the acceptor.
dimensions (list) --
Defines the dimensions that the acceptor has purchased from the overall set of dimensions presented in the rate card.
(dict) --
Defines the dimensions that the acceptor has purchased from the overall set of dimensions presented in the rate card.
dimensionKey (string) --
The name of key value of the dimension.
dimensionValue (integer) --
The number of units of the dimension the acceptor has purchased.
byolPricingTerm (dict) --
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.
id (string) --
The unique identifier for the term.
recurringPaymentTerm (dict) --
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.
id (string) --
The unique identifier for the term.
currencyCode (string) --
Defines the currency for the prices mentioned in this term.
billingPeriod (string) --
Defines the recurrence at which buyers are charged.
price (string) --
Amount charged to the buyer every billing period.
validityTerm (dict) --
Defines the conditions that will keep an agreement created from this offer valid.
type (string) --
Category of the term being updated.
id (string) --
The unique identifier for the term.
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.
agreementStartDate (datetime) --
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 (datetime) --
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 (dict) --
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.
id (string) --
The unique identifier for the term.
currencyCode (string) --
Defines the currency for the prices mentioned in the term.
schedule (list) --
List of the payment schedule where each element defines one installment of payment. It contains the information necessary for calculating the price.
(dict) --
An individual installment of the payment that includes the date and amount of the charge.
chargeDate (datetime) --
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).
freeTrialPricingTerm (dict) --
Defines a short-term free pricing model where the buyers aren’t charged anything within a specified limit.
type (string) --
Category of the term.
id (string) --
The unique identifier for the terms.
duration (string) --
Duration of the free trial period (5–31 days).
grants (list) --
Entitlements granted to the acceptor of a free trial as part of an agreement execution.
(dict) --
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.
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.
fixedUpfrontPricingTerm (dict) --
Defines a pre-paid pricing model where the customers are charged a fixed upfront amount.
type (string) --
Category of the term being updated.
id (string) --
The unique identifier for the term.
currencyCode (string) --
Defines the currency for the prices mentioned in this term.
duration (string) --
Contract duration for the terms.
price (string) --
Fixed amount to be charged to the customer when this term is accepted.
grants (list) --
Entitlements granted to the acceptor of fixed upfront as part of agreement execution.
(dict) --
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.
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.
variablePaymentTerm (dict) --
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.
id (string) --
The unique identifier for the term.
currencyCode (string) --
Defines the currency for the prices mentioned in the term.
maxTotalChargeAmount (string) --
The maximum total amount that can be charged to the customer through variable payment requests under this term.
configuration (dict) --
Additional parameters specified by the acceptor while accepting the term.
paymentRequestApprovalStrategy (string) --
Defines the strategy for approving payment requests. Values include AUTO_APPROVE_ON_EXPIRATION and 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).
nextToken (string) --
The token used for pagination. The field is null if there are no more results.