Welcome - AWS Marketplace Metering Service

Welcome

This reference provides descriptions of the low-level AWS Marketplace Metering Service API.

AWS Marketplace sellers can use this API to submit usage data for custom usage dimensions.

For information about the permissions that you need to use this API, see AWS Marketplace metering and entitlement API permissions in the AWS Marketplace Seller Guide.

Submitting metering records

MeterUsage

  • Submits the metering record for an AWS Marketplace product.

  • Called from: Amazon Elastic Compute Cloud (Amazon EC2) instance or a container running on either Amazon Elastic Kubernetes Service (Amazon EKS) or Amazon Elastic Container Service (Amazon ECS)

  • Supported product types: Amazon Machine Images (AMIs) and containers

  • Vendor-metered tagging: Supported allocation tagging

BatchMeterUsage

  • Submits the metering record for a set of customers. BatchMeterUsage API calls are captured by AWS CloudTrail. You can use CloudTrail to verify that the software as a subscription (SaaS) metering records that you sent are accurate by searching for records with the eventName of BatchMeterUsage. You can also use CloudTrail to audit records over time. For more information, see the AWS CloudTrail User Guide.

  • Called from: SaaS applications

  • Supported product type: SaaS

  • Vendor-metered tagging: Supports allocation tagging

Accepting new customers

ResolveCustomer

  • Resolves the registration token that the buyer submits through the browser during the registration process. Obtains a CustomerIdentifier along with the CustomerAWSAccountId and ProductCode.

  • Called from: SaaS application during the registration process

  • Supported product type: SaaS

  • Vendor-metered tagging: Not applicable

Entitlement and Metering for Paid Container Products

RegisteredUsage

  • Provides software entitlement and metering. Paid container software products sold through AWS Marketplace must integrate with the AWS Marketplace Metering Service and call the RegisterUsage operation. Free and Bring Your Own License model (BYOL) products for Amazon ECS or Amazon EKS aren't required to call RegisterUsage. However, you can do so if you want to receive usage data in your seller reports. For more information about using the RegisterUsage operation, see Container-based products.

  • Called from: Paid container software products

  • Supported product type: Containers

  • Vendor-metered tagging: Not applicable

This document was last published on September 23, 2022.