Amazon SNS notifications for SaaS products - AWS Marketplace
Amazon SNS topic: aws-mp-entitlement-notificationAmazon SNS topic: aws-mp-subscription-notificationSubscribing an SQS queue to the SNS topic

Amazon SNS notifications for SaaS products

To receive notifications, you subscribe to the AWS Marketplace Amazon Simple Notification Service (Amazon SNS) topics provided to you during product creation. The topics provide notifications about changes to customers’ subscriptions and contract entitlements for your products. This enables you to know when to provide and revoke access for specific customers.

Note

During the product creation process, you'll receive the actual Amazon Resource Name (ARN) to the SNS topic. For example: arn:aws:sns:us-east-1:123456789012:aws-mp-subscription-notification-PRODUCTCODE

The following Amazon SNS topics are available to software as a service (SaaS) products:

  • Amazon SNS topic: aws-mp-entitlement-notification – This topic notifies you when buyers create a new contract, upgrade it, renew it, or it expires. This is only available for products with pricing models that include a contract (also known as SaaS Contracts and SaaS Contracts with Consumption (Overages)).

  • Amazon SNS topic: aws-mp-subscription-notification – This topic notifies you when a buyer subscribes to or unsubscribes from a product and includes the offer-identifier for private offers and a free trials flag for SaaS free trials. This is available for all pricing models, including contracts and subscriptions (also known as SaaS Subscriptions, SaaS Contracts, and SaaS Contracts with Consumption (Overages).

To learn more about the scenarios in which you respond to these notifications, see the following topics:

Amazon SNS topic: aws-mp-entitlement-notification

Each message in the aws-mp-entitlement-notification topic has the following format.

{
    "action": "<action-name>",
    "customer-identifier": " X01EXAMPLEX",
    "product-code": "n0123EXAMPLEXXXXXXXXXXXX",
}

The <action-name> will always be entitlement-updated.

Note

  • For entitlement messages, regardless of the action (new, upgrade, renewal, or expired), the message is the same. A subsequent call to GetEntitlement is required to discover the content of the update.

  • For SaaS Contract with Consumption (Overages), sellers are provided with the aws-mp-subscription-notification SNS topic. This is an extra notification that a seller receives when they add on overage pricing. When a seller acquires new customers, instead of only getting entitlement-updated (which may refer to any kind of action), the seller receives a subscribe message indicating that this is a new customer.

  • For future dated agreements (FDAs), this topic is initiated on the agreement start date (and not agreement sign date). It's also initiated when subsequent changes occur in the entitlement, such as cancellation, replacement, renewal, or expiration of the agreement.

Products with contract pricing (including contracts with pay-as-you-go) must respond to these messages. For more information about how to respond, see Scenario: Monitor changes to user subscriptions.

Amazon SNS topic: aws-mp-subscription-notification

Each message in the aws-mp-subscription-notification topic has the following format.

{
    "action": "<action-name>",
    "customer-identifier": " X01EXAMPLEX",
    "product-code": "n0123EXAMPLEXXXXXXXXXXXX",
    "offer-identifier": "offer-abcexample123",
    "isFreeTrialTermPresent":"true"
}

The offer-identifier only appears in the notification if the offer is a private offer.

The isFreeTrialTermPresent property indicates if the buyer's subscription is a free trial. The JSON value of this property is not a boolean datatype. Instead, the value is converted to a string datatype. For more information, see SaaS free trials.

The <action-name> will vary depending on the notification. Possible actions are:

  • subscribe-success – The subscribe-success message signals when the seller can begin sending metering records.

  • subscribe-fail – If the subscribe-fail message is generated, payment might have failed even though the buyer has already transitioned from the AWS Marketplace to the seller's SaaS landing page. The seller should wait for the subscribe-success message before allowing consumption of the product.

  • unsubscribe-pending – When a buyer unsubscribes, an unsubscribe-pending message is sent first. This indicates that the seller has a limited time (about one hour) to get final metering records sent before the buyer is cancelled completely.

  • unsubscribe-success – The unsubscribe-success message signals the completion of cancellation, after which no further metering records will be accepted.

Note

  • If a buyer unsubscribes and then immediately successfully re-subscribes before the final unsubscribe-success message is sent, the final unsubscribe-success message will not be sent and a subscribe-success message will be sent instead.

  • For future dated agreements (FDAs), the subscribe success action is initiated on the agreement start date (and not agreement sign date).

Products with subscription pricing (including contracts with pay-as-you-go) must respond to these messages. For more information about how to respond, see the following topics:

Subscribing an SQS queue to the SNS topic

We recommend subscribing an Amazon SQS queue to the provided SNS topics. For detailed instructions on creating an SQS queue and subscribing the queue to a topic, see Subscribing an Amazon SQS queue to an Amazon SNS topic in the Amazon Simple Notification Service Developer Guide.

Note

You can only subscribe to AWS Marketplace SNS topics from the AWS account used to sell the products. However, you can forward the messages to a different account. For more information, see Sending Amazon SNS messages to an Amazon SQS queue in a different account in the Amazon Simple Notification Service Developer Guide.

Polling the SQS queue for notifications

After you subscribe your SQS queue to an SNS topic, the messages are stored in SQS. You must define a service that continually polls the queue, looks for messages, and handles them accordingly.