Subscription Activate

After a customer confirms a purchase of a recurring billing subscription, an API call with the user ID, product ID, and subscription ID is made to your fulfill endpoint. The response must indicate whether the subscription was successfully activated. Independently of the SDK, you will be interacting with SubscriptionActivateRequest and SubscriptionActivateResponse.

SubscriptionActivateRequest

Field Description
operation Always SubscriptionActivate.
subscriptionId An identifier for the subscription. Always present.
productId The third party product code for the item that is fulfilled. This is provided to Amazon when the item is ingested. Always present.
userId The customer ID (provided to Amazon in the Link response) that identifies which user to deliver the item to. Always present.
subscriptionGroupId An identifier for the subscription group. Required for Team Subscriptions, otherwise missing.
numberOfSubscriptionsInGroup The number of subscriptions in the subscription group when customer initially purchased the subscription. We currently do not have a way to communicate quantity change to vendor without having customer activating a subscription, so this number may not be up to date. Required for Team Subscriptions, otherwise missing.

SubscriptionActivateResponse

Field Description
response Valid response codes are:
OK
FAIL_USER_NOT_ELIGIBLE (User is not eligible to purchase the subscription due to eligibility rules)
FAIL_USER_INVALID (User Id sent was invalid)
FAIL_INVALID_SUBSCRIPTION (when an activation request to a team product does not contain subscriptionGroupId and numberOfSubscriptions, or an activation request sent to a regular product contains unexpected subscriptionGroupId and numberOfSubscriptions.)
FAIL_OTHER (Catch all Error code)

A note about Free Trials

Recently, Amazon has introduced the concept of Free Trial Subscriptions. Please note that these subscription activate calls will look the exact same as paid subscription calls and it will be up to the vendor to take appropriate action.