Skip to content

ResolveCustomer is called by a SaaS application during the registration process

Description

resolve_customer is called by a SaaS application during the registration process. When a buyer visits your website during the registration process, the buyer submits a registration token through their browser. The registration token is resolved through this API to obtain a CustomerIdentifier along with the CustomerAWSAccountId, ProductCode, and LicenseArn.

For new SaaS product integrations, the CustomerIdentifier field is not populated in the resolve_customer API response. New integrations must use CustomerAWSAccountId and LicenseArn to identify customers. Existing integrations continue to work unchanged.

To successfully resolve the token, the API must be called from the account that was used to publish the SaaS application. For an example of using resolve_customer, see ResolveCustomer code example in the Amazon Web Services Marketplace Seller Guide.

Permission is required for this operation. Your IAM role or user performing this operation requires a policy to allow the aws-marketplace:ResolveCustomer action. For more information, see Actions, resources, and condition keys for Amazon Web Services Marketplace Metering Service in the Service Authorization Reference.

For Amazon Web Services Regions that support resolve_customer, see ResolveCustomer Region support.

Usage

marketplacemetering_resolve_customer(RegistrationToken)

Arguments

  • RegistrationToken

    [required] When a buyer visits your website during the registration process, the buyer submits a registration token through the browser. The registration token is resolved to obtain a CustomerIdentifier along with the CustomerAWSAccountId, ProductCode, and LicenseArn.

    For new SaaS product integrations, the CustomerIdentifier field is not populated. Use CustomerAWSAccountId and LicenseArn for customer identification.

Value

A list with the following syntax:

list(
  CustomerIdentifier = "string",
  ProductCode = "string",
  CustomerAWSAccountId = "string",
  LicenseArn = "string"
)

Request syntax

svc$resolve_customer(
  RegistrationToken = "string"
)