AWS marketplace documentation change
Summary
Updated SaaS contract documentation with restructured sections, clarified pricing dimension definitions, added new 'Understanding SaaS contract pricing dimensions' section, and updated notification method from SNS to EventBridge.
Security assessment
The changes focus on improving documentation structure, pricing dimension explanations, and service integration updates (SNS to EventBridge). There is no evidence of addressing security vulnerabilities or introducing security-specific content. The Metering Service/Entitlement Service references relate to standard billing operations.
Diff
diff --git a/marketplace/latest/userguide/saas-contracts.md b/marketplace/latest/userguide/saas-contracts.md index c810e7d89..be786e607 100644 --- a//marketplace/latest/userguide/saas-contracts.md +++ b//marketplace/latest/userguide/saas-contracts.md @@ -5 +5 @@ -SaaS contract upgradesAutomatic renewalsWhen a SaaS contract endsWhen a SaaS contract is canceled +Creating a SaaS contract productUnderstanding SaaS contract pricing dimensionsSaaS contract upgradesAutomatic renewalsWhen a SaaS contract endsWhen a SaaS contract is canceled @@ -9 +9 @@ SaaS contract upgradesAutomatic renewalsWhen a SaaS contract endsWhen a SaaS con -For software as a service (SaaS) contracts, the customer initiates a purchase of your software and enters into an agreement with you. Under the agreement, the customer is entitled to a specified quantity of use of your SaaS product. AWS Marketplace communicates these entitlements to your SaaS application. This is done through the AWS Marketplace Entitlement Service. When using the SaaS Contract pricing model, your application never sends metering records. Instead, it verifies entitlement by calling the AWS Marketplace Entitlement Service. You define the usage categories, dimensions, and the length of the contract. +SaaS contracts allow customers to purchase your software through an upfront agreement. Under the agreement, customers are entitled to a specified quantity of use of your SaaS product. You define the usage categories, dimensions, and the length of the contract. AWS Marketplace bills your customers upfront or by the payment schedule that you define. For additional usage above their contract, your software reports the usage through the AWS Marketplace Metering Service (AWS Marketplace Metering Service). @@ -11 +11,3 @@ For software as a service (SaaS) contracts, the customer initiates a purchase of -AWS Marketplace bills your customers upfront or by the payment schedule that you define, based on the contract between you and your customer. After that point, they're entitled to use those resources. For additional usage above their contract, your software needs to report the usage and AWS Marketplace bills your customers based on the metering records received by us through the AWS Marketplace Metering Service. +When using the SaaS Contract pricing model, your application never sends metering records. Instead, it verifies entitlement by calling the AWS Marketplace Entitlement Service (AWS Marketplace Entitlement Service). AWS Marketplace communicates these entitlements to your SaaS application. + +## Creating a SaaS contract product @@ -15 +17 @@ Before you can publish a SaaS product with contract pricing, you must do the fol - 1. Create a new SaaS product in the AWS Marketplace Management Portal, and choose **New SaaS Contract**. + 1. Create a new SaaS product in the AWS Marketplace Management Portal, and choose **New SaaS contract**. @@ -21 +23 @@ Before you can publish a SaaS product with contract pricing, you must do the fol - 1. For **Set Pricing** , choose the **Contract Duration** you want offer customers. You can enter different prices for each contract duration. You can select one or more of the following options: **Monthly** , **1 year** , **2 Years** , and **3 Years**. If you are creating a private offer, you can choose a custom duration in months (up to 60 months). + 1. For **Set pricing** , choose the **Contract duration** you want to offer customers. You can enter different prices for each contract duration. You can select one or more of the following options: **Monthly** , **1 year** , **2 years** , and **3 years**. If you are creating a private offer, you can choose a custom duration in months (up to 60 months). @@ -31 +33,8 @@ Before you can publish a SaaS product with contract pricing, you must do the fol - 4. After you choose a category, define your Pricing Dimensions. Each dimension represents a feature or service that you can set a per-unit price for. Examples of dimensions are users, hosts scanned, and GB of logs ingested. You can define a maximum of 200 dimensions. For each dimension you define, you add a name, a description, a price, and an API name. The name, price, and description are displayed to customers. You use the API name for tracking and reporting with AWS Marketplace as follows: + 4. Define your pricing dimensions. Each dimension represents a feature or service that you want to price separately. For detailed information about pricing dimensions and the required fields, see Understanding SaaS contract pricing dimensions. + + + + +## Understanding SaaS contract pricing dimensions + +Each pricing dimension represents a feature or service that you can set a per unit price for. Examples of dimensions are users, hosts scanned, and GB of logs ingested. For each dimension you define, you add a name, a description, a price, and an API name. The name, price, and description are displayed to customers. You use the API name for tracking and reporting with AWS Marketplace as follows: @@ -41 +53,19 @@ When using the wizard to create the contracts for your SaaS product, you must de - * **Dimension API Name** – The name used when calling the Entitlements API. This name is visible in billing reports and reports that aren't external-facing. The maximum length for the API name is 15 characters. After you set the name, it can't be changed. +**Dimension API name** + + +The name used when calling the Entitlements API. This name is visible in billing reports and reports that aren't external-facing. The maximum length for the API name is 15 characters. After you set the name, it can't be changed. + +**Dimension display name** + + +The customer-facing name of a dimension. This name should help the customer understand the dimension for the product. The name should be user-friendly, and its maximum length is 24 characters. This value can be changed. + +**Dimension description** + + +The customer-facing description of a dimension that provides additional information about the dimension for the product. The maximum length for the description is 70 characters. + +**Dimension - monthly price** + + +The software charge per unit for the 1-month option for this dimension. This field supports three decimal places. @@ -43 +73 @@ When using the wizard to create the contracts for your SaaS product, you must de - * **Dimension Display Name** : – The customer-facing name of a dimension. This name should help the customer understand the dimension for the product. The name should be user-friendly, and its maximum length is 24 characters. This value can be changed. +**Dimension - 1-year price** @@ -45 +74,0 @@ When using the wizard to create the contracts for your SaaS product, you must de - * **Dimension Description** : – The customer-facing description of a dimension that provides additional information about the dimension for the product. The maximum length for the description is 70 characters. @@ -47 +76 @@ When using the wizard to create the contracts for your SaaS product, you must de - * **Dimension - Monthly Price** – The software charge per unit for the 1-month option for this dimension. This field supports three decimal places. +The software charge per unit for the 12-month option for this dimension. This field supports three decimal places. It's not a monthly charge. The price must reflect the 12-month one-time charge price. @@ -49 +78 @@ When using the wizard to create the contracts for your SaaS product, you must de - * **Dimension - 1 Year Price** – The software charge per unit for the 12-month option for this dimension. This field supports three decimal places. It's not a monthly charge. The price must reflect the 12-month one-time charge price. +**Dimension - 2-year price** @@ -51 +79,0 @@ When using the wizard to create the contracts for your SaaS product, you must de - * **Dimension - 2 Years Price** – The software charge per unit for the 24-month option for this dimension. This field supports three decimal places. @@ -53 +81 @@ When using the wizard to create the contracts for your SaaS product, you must de - * **Dimension - 3 Years Price** – The software charge per unit for the 36-month option for this dimension. This field supports three decimal places. +The software charge per unit for the 24-month option for this dimension. This field supports three decimal places. @@ -54,0 +83 @@ When using the wizard to create the contracts for your SaaS product, you must de +**Dimension - 3-year price** @@ -56,0 +86 @@ When using the wizard to create the contracts for your SaaS product, you must de +The software charge per unit for the 36-month option for this dimension. This field supports three decimal places. @@ -106 +136 @@ The full or prorated refund is typically granted in 3–5 business days. - 2. Your SaaS product is sent notification through the Amazon SNS topic for that customer. + 2. Your SaaS product receives notification through Amazon EventBridge events for that customer.