ByolPricingTerm byolPricingTerm
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.
ConfigurableUpfrontPricingTerm configurableUpfrontPricingTerm
Defines a prepaid payment model that allows buyers to configure the entitlements they want to purchase and the duration.
FixedUpfrontPricingTerm fixedUpfrontPricingTerm
Defines a pre-paid pricing model where the customers are charged a fixed upfront amount.
FreeTrialPricingTerm freeTrialPricingTerm
Defines a short-term free pricing model where the buyers aren’t charged anything within a specified limit.
LegalTerm legalTerm
Defines the list of text agreements proposed to the acceptors. An example is the end user license agreement (EULA).
PaymentScheduleTerm paymentScheduleTerm
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.
RecurringPaymentTerm recurringPaymentTerm
Defines a pricing model where customers are charged a fixed recurring price at the end of each billing period.
RenewalTerm renewalTerm
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.
SupportTerm supportTerm
Defines the customer support available for the acceptors when they purchase the software.
UsageBasedPricingTerm usageBasedPricingTerm
Defines a usage-based pricing model (typically, pay-as-you-go pricing), where the customers are charged based on product usage.
ValidityTerm validityTerm
Defines the conditions that will keep an agreement created from this offer valid.
String accountId
The AWS account ID of the acceptor.
String requestId
The unique identifier for the error.
Date acceptanceTime
The date and time that the agreement was accepted.
Acceptor acceptor
Details of the party accepting the agreement terms. This is commonly the buyer for
PurchaseAgreement.
String agreementId
The unique identifier of the agreement.
String agreementType
The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement.
Date endTime
The date and time when the agreement ends. The field is null for pay-as-you-go agreements, which
don’t have end dates.
ProposalSummary proposalSummary
A summary of the proposal
Proposer proposer
Details of the party proposing the agreement terms, most commonly the seller for PurchaseAgreement.
Date startTime
The date and time when the agreement starts.
String status
The current status of the agreement.
String type
Type of the term being updated.
ConfigurableUpfrontPricingTermConfiguration configuration
Additional parameters specified by the acceptor while accepting the term.
String currencyCode
Defines the currency for the prices mentioned in the term.
List<E> rateCards
A rate card defines the per unit rates for product dimensions.
String type
Category of selector.
Constraints constraints
Defines limits on how the term can be configured by acceptors.
List<E> rateCard
Defines the per unit rates for product dimensions.
Selector selector
Differentiates between the mutually exclusive rate cards in the same pricing term to be selected by the buyer.
String multipleDimensionSelection
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.
String quantityConfiguration
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.
String agreementId
The unique identifier of the agreement.
Date acceptanceTime
The date and time the offer was accepted or the agreement was created.
AcceptanceTime and StartTime can differ for future dated agreements (FDAs).
Acceptor acceptor
The details of the party accepting the agreement terms. This is commonly the buyer for
PurchaseAgreement.
String agreementId
The unique identifier of the agreement.
String agreementType
The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement.
Date endTime
The date and time when the agreement ends. The field is null for pay-as-you-go agreements, which
don’t have end dates.
EstimatedCharges estimatedCharges
The estimated cost of the agreement.
ProposalSummary proposalSummary
A summary of the proposal received from the proposer.
Proposer proposer
The details of the party proposing the agreement terms. This is commonly the seller for
PurchaseAgreement.
Date startTime
The date and time when the agreement starts.
String status
The current status of the agreement.
Statuses include:
ACTIVE – The terms of the agreement are active.
ARCHIVED – The agreement ended without a specified reason.
CANCELLED – The acceptor ended the agreement before the defined end date.
EXPIRED – The agreement ended on the defined end date.
RENEWED – The agreement was renewed into a new agreement (for example, an auto-renewal).
REPLACED – The agreement was replaced using an agreement replacement offer.
ROLLED_BACK (Only applicable to inactive agreement revisions) – The agreement revision has been
rolled back because of an error. An earlier revision is now active.
SUPERCEDED (Only applicable to inactive agreement revisions) – The agreement revision is no longer
active and another agreement revision is now active.
TERMINATED – The agreement ended before the defined end date because of an AWS termination (for
example, a payment failure).
String dimensionKey
The name of key value of the dimension.
Integer dimensionValue
The number of units of the dimension the acceptor has purchased.
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.
String type
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.
String url
A URL to the legal document for buyers to read. Required when Type is CustomEula.
String version
Version of standard contracts provided by AWS Marketplace. Required when Type is StandardEula or
StandardDsa.
String agreementValue
The total known amount customer has to pay across the lifecycle of the agreement.
This is the total contract value if accepted terms contain ConfigurableUpfrontPricingTerm or
FixedUpfrontPricingTerm. In the case of pure contract pricing, this will be the total value of the
contract. In the case of contracts with consumption pricing, this will only include the committed value and not
include any overages that occur.
If the accepted terms contain PaymentScheduleTerm, it will be the total payment schedule amount.
This occurs when flexible payment schedule is used, and is the sum of all invoice charges in the payment
schedule.
In case a customer has amended an agreement, by purchasing more units of any dimension, this will include both the original cost as well as the added cost incurred due to addition of new units.
This is 0 if the accepted terms contain UsageBasedPricingTerm without
ConfigurableUpfrontPricingTerm or RecurringPaymentTerm. This occurs for usage-based
pricing (such as SaaS metered or AMI/container hourly or monthly), because the exact usage is not known upfront.
String currencyCode
Defines the currency code for the charge.
String currencyCode
Defines the currency for the prices mentioned in this term.
String duration
Contract duration for the terms.
List<E> grants
Entitlements granted to the acceptor of fixed upfront as part of agreement execution.
String price
Fixed amount to be charged to the customer when this term is accepted.
String type
Category of the term being updated.
String dimensionKey
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.
Integer maxQuantity
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.
String requestId
The unique identifier for the error.
String currencyCode
Defines the currency for the prices mentioned in the term.
List<E> schedule
List of the payment schedule where each element defines one installment of payment. It contains the information necessary for calculating the price.
String type
Type of the term.
String accountId
The AWS account ID of the proposer.
String dimensionKey
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.
String price
Per unit price for the product dimension that’s used for calculating the amount to be charged.
RenewalTermConfiguration configuration
Additional parameters specified by the acceptor while accepting the term.
String type
Category of the term being updated.
Boolean enableAutoRenew
Defines whether the acceptor has chosen to auto-renew the agreement at the end of its lifecycle. Can be set to
True or False.
String catalog
The catalog in which the agreement was created.
List<E> filters
The filter name and value pair used to return a specific list of results.
The following filters are supported:
ResourceIdentifier – The unique identifier of the resource.
ResourceType – Type of the resource, which is the product (AmiProduct,
ContainerProduct, or SaaSProduct).
PartyType – The party type (either Acceptor or Proposer) of the caller.
For agreements where the caller is the proposer, use the Proposer filter. For agreements where the
caller is the acceptor, use the Acceptor filter.
AcceptorAccountId – The AWS account ID of the party accepting the agreement terms.
OfferId – The unique identifier of the offer in which the terms are registered in the agreement
token.
Status – The current status of the agreement. Values include ACTIVE,
ARCHIVED, CANCELLED, EXPIRED, RENEWED, REPLACED,
and TERMINATED.
BeforeEndTime – A date used to filter agreements with a date before the endTime of an
agreement.
AfterEndTime – A date used to filter agreements with a date after the endTime of an
agreement.
AgreementType – The type of agreement. Values include PurchaseAgreement or
VendorInsightsAgreement.
Integer maxResults
The maximum number of agreements to return in the response.
String nextToken
A token to specify where to start pagination.
Sort sort
An object that contains the SortBy and SortOrder attributes.
String requestId
The unique identifier for the error.
String agreementDuration
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.
Date agreementEndDate
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.
Date agreementStartDate
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.
String type
Category of the term being updated.
Copyright © 2024. All rights reserved.