Set Up Quick Subscribe

For an overview of Quick Subscribe, see Quick Subscribe Overview. When you're ready to get started, contact your Amazon representative to have them enable Quick Subscribe on your account. Then, follow the steps on this page.

• Prerequisites
• Step 1: Configure Quick Subscribe in the Developer Console
• Step 2: Configure security profile
• Step 3: Implement getPurchaseUpdates
• Step 4: Integrate with RVS
• Step 5: Send fulfillment result to Amazon
• Step 6: Integrate with RTN
• Step 7: Integrate one-click account information sharing
• Step 8: Test Quick Subscribe with LAT
• Related topics

Prerequisites

Integrate with the Appstore SDK version 3.0.6 or higher. For details, see Integrate the Appstore SDK.

Step 1: Configure Quick Subscribe in the Developer Console

To configure Quick Subscribe for your app, follow these steps

1. Sign in to the Developer Console.
2. In your app list, find the app you want to set up with Quick Subscribe.
3. In the In-App Items column, click the link to open the In-App Items screen.
4. Select Create Quick Subscription.
5. An overlay pop-up appears as shown in the following image.

   

   In the Choose default subscription drop down, the list is populated with your existing IAP subscriptions. Choose the subscription on which you want to enable Quick Subscribe.

6. In the Select term drop down, choose a term for the quick subscription.
7. If you would like to offer additional subscriptions for Quick Subscribe, select Add another quick subscription. You can add a maximum of four quick subscriptions.
8. Choose your target devices for Quick Subscribe by checking the boxes.
9. Choose whether to create the quick subscription for Live App Testing (LAT) only or for both LAT and your live app.
   • To create a quick subscription for LAT only, select Create Quick Subscription for Test.
   • To create the quick subscription for both LAT and the live app, select Create Quick Subscription for Test and Live.
   Note: For details on how to use LAT to test Quick Subscribe, see Test Quick Subscribe with LAT.

After you create a quick subscription, you can delete or modify it by selecting Actions next to the Quick Subscribe item.

Step 2: Configure security profile

To configure a security profile for your app, follow these steps

1. Sign in to the Developer Console.
2. Open the app list and select your app.
3. Select App Services and scroll to the Security Profile section.
4. Click Select existing security profile or create new to expand the options.
5. Use the drop-down to select the security profile that you want to map to this app, then click Enable Security Profile. Alternatively, you can create a new security profile by clicking Create Security Profile.

Step 3: Implement getPurchaseUpdates

The getPurchaseUpdates() method gets the user's receipts. Quick Subscribe uses the information from getPurchaseUpdates() to verify your user's purchase status, ensuring that the user has access to the content to which they are entitled.

Call getPurchaseUpdates() in the onResume() method. The getPurchaseUpdates() method takes one boolean parameter, reset. Set reset to false to return only the new receipts since the last time you called this method. Set reset to true to return all of the receipts for this user.

@Override
protected void onResume() {
  super.onResume();

//...

  PurchasingService.getUserData();

//...

  PurchasingService.getPurchaseUpdates(false);
}

For more information on how to integrate the getPurchaseUpdates() method, see IAP API documentation:

• Android—Implement getPurchaseUpdates method
• Web app—getPurchaseUpdates(reset)

Implementation requirements

Follow these requirements to properly implement the getPurchaseUpdates() method.

• You must call getPurchaseUpdates() in the onResume() lifecycle method of the Android activity.
• Always use the false flag while calling getPurchaseUpdates() in onResume() to get the latest receipts. If you use the true flag, it returns the full history of receipts, and you would have to add extra filtering logic to handle the response.
• Add a "Restore Purchases" option in your app which calls getPurchaseUpdates() with the true flag when selected by a customer.
• The receipts received through getPurchaseUpdates() must always be persisted and must be mapped to the app's login ID. Use this mapping to unlock the subscribed content to customers when they open the app.

Step 4: Integrate with RVS

The Receipt Verification Service (RVS) lets you validate purchases made by your app's users. When you make a request to the RVS server, the JSON response returned includes a purchaseMetadataMap field. If the purchase was initiated using Quick Subscribe, the purchaseMetadataMap appears as {"QuickSubscribe":"true"}, as seen in the following example.

{
  "autoRenewing": true,
  "betaProduct": false,
  "binCountryCode": null,
  "cancelDate": 1641131573000,
  "cancelReason": 2,
  "deferredDate": null,
  "deferredSku": null,
  "freeTrialEndDate": null,
  "fulfillmentDate": 1641131345000,
  "fulfillmentResult": "FULFILLED",
  "gracePeriodEndDate": null,
  "parentProductId": null,
  "productId": "IntroFreeTrial.sku",
  "productType": "SUBSCRIPTION",
  "promotions": null,
  "purchaseDate": 1641131345000,
  "purchaseMetadataMap": {
      "QuickSubscribe": "true"
  },
  "quantity": null,
  "receiptId": "k9om1rUS7gZJIg8RMfw7AlbxA3aP56ay-vdgeLU40zw=:3:11",
  "renewalDate": null,
  "term": "1 Month",
  "termSku": null,
  "testTransaction": false
}

If the purchase wasn't initiated using Quick Subscribe, purchaseMetadataMap appears as null. The following table provides a description for all fields in the response object.

For more details on RVS, see Receipt Verification Service for Appstore SDK IAP.

Step 5: Send fulfillment result to Amazon

When you send a fulfillment result, you ensure that Amazon can confirm whether users can access the content that they paid for. Always communicate the fulfillment result to Amazon. To do this, use the notifyFulfillment() method included in the Appstore SDK.

After a customer signs in, call notifyFulfillment() with status FULFILLED when the subscription is fulfilled. If the customer already has a subscription, call notifyFulfillment() with status UNAVAILABLE to indicate that the customer has signed in but the purchase isn't applicable. For more information about the notifyFulfillment() method, see Send fulfillment result to Amazon and grant item to the user.

If you've previously integrated with the Acknowledge Receipt API, you can continue to use it in place of the notifyFulfillment() method. You must use either the notifyFulfillment() method or the Acknowledge Receipt API in your app to communicate the fulfillment result to Amazon.

Implementation requirements

Follow these requirements to properly implement the notifyFulfillment() method.

• You must call notifyFulfillment() every time the customer opens the app and tries to access content.
• If you successfully map a customer to a receipt and unlock subscription content for the customer, you must call notifyFulfillment() with the FULFILLED status.
• If you identify that the customer has an existing subscription, you must call notifyFulfillment() with the UNAVAILABLE status.
• If you called notifyFulfillment() with UNAVAILABLE due to an issue, make sure to call notifyFulfillment() with the FULFILLED status when you successfully map the customer to the receipt and unlock the subscription content for the customer.

Acknowledge Receipt API

Open/Close Acknowledge Receipt API details  

PUT https://appstore-sdk.amazon.com/version/1.0/acknowledgeReceipt?developer={shared-secret}&user={user-id}=&receiptId={receipt-id}&fulfillmentResult={fulfillment-result}

Step 6: Integrate with RTN

With Quick Subscribe, customers subscribe to your app through Amazon, rather than through your app. This could lead to your app missing some information about a customer's purchase state. The getPurchaseUpdates() method sends data only when an app is opened.

Real Time Notifications (RTN) provides customer purchase information for all transactions, including the ones that occur outside your app. When your server receives a purchase notification from Amazon's RTN server, use the Receipt Verification Service for Appstore SDK IAP (RVS) to validate the receipt.

For details about how to set up RTN, see Use Real-Time Notifications.

Step 7: Integrate one-click account information sharing

Use this guide to integrate your app with the one-click account information sharing feature.

Update app manifest

To indicate to the Appstore that your app supports the one-click account information sharing feature, update your app's manifest with the following code.

<uses-feature android:name="amazon.lwa.quicksignup.supported"/>

Implement getUserData changes

To determine whether a customer has explicitly consented to share their Amazon account details with your app, you must implement the following process during your app's initialization.

In the onCreate() method of your app's main activity:

• Create a new UserDataRequest object and configure it to request the customer's profile consent status information. To configure the UserDataRequest object to request consent status, set its setFetchUserProfileAccessConsentStatus() method to true.
• Call the getUserData() method and pass the configured UserDataRequest object to it.

The following example shows how to build a UserDataRequest object and pass it to getUserData().

@Override
protected void onCreate(Bundle savedInstanceState)
{
    super.onCreate(savedInstanceState);
    
    //...
    
    // Pass the reference of PurchasingListener to be registered
    PurchasingService.registerListener(this.getApplicationContext(), purchasingListener);
    
    // Pass the reference of UserProfileAccessListener to be registered
    PurchasingService.registerUserProfileAccessListener(this.getApplicationContext(), userProfileAccessListener);
     
    // Implement logic to identify customer logged in status inside isLoggedIn()
    if (!isLoggedIn()) {
        PurchasingService.getUserData(UserDataRequest.newBuilder().setFetchUserProfileAccessConsentStatus(true).build());
    }
    //...
}

Implement the onUserDataResponse() callback method to get the UserDataResponse object, which contains customer consent data. The following code shows how to handle the consent data received from the UserDataResponse object.

@Override
public void onUserDataResponse(final UserDataResponse response) {

    UserDataResponse.RequestStatus status = response.getRequestStatus();

    switch (status) {
        case SUCCESSFUL:
            if (UserProfileAccessConsentStatus.CONSENTED.equals(response.getUserData().getUserProfileAccessConsentStatus())) {
                // Initiate the custom loader screen or spinner.
                PurchasingService.requestUserProfileAccess();
            }
            break;

        case FAILED:
        case NOT_SUPPORTED:
            // Fail gracefully.
            break;
    }
}

If a customer provides consent, the UserProfileAccessConsentStatus of the UserData object has the status CONSENTED. If a customer doesn't provide consent or if the consent token expires, UserProfileAccessConsentStatus has the status UNAVAILABLE.

If the customer provides consent, call the requestUserProfileAccess() method and update your server with the authorization code found in the response object. Then, use the REST APIs provided by Appstore SDK to get an access token and the customer profile. Create an account in your system with the user information shared.

The following code shows how to extract the user profile access authorization code from the UserProfileAccessResponse object.

@Override
public void onUserProfileAccessResponse(final UserProfileAccessResponse response) {
    
    UserProfileAccessResponse.RequestStatus status = response.getRequestStatus();
    
    switch (status) {
        case SUCCESSFUL:
            // Here you should update your server with the userProfileAccessAuthCode 
            // to further interact with Appstore SDK REST APIs to get access token and customer profile.
            final String userProfileAccessAuthCode = response.getUserProfileAccessAuthCode();
            break;
    
        case FAILED:
        case NOT_SUPPORTED:
            // Fail gracefully.
            break;
    } 
}

If the customer doesn't provide consent, show your own sign-in screen. The customer can then enter their credentials using the keyboard to sign in to your app.

Get Access Token API

The Appstore SDK provides the Get Access Token REST API for you to obtain an access token. This section describes the request, response, and errors.

Access token request

After the app receives an authorization response with a valid authorization code, it can use that code to obtain an access token. With an access token, the client can read a customer profile.

The Get Access Token API must use a POST request rather than a GET request, as shown in the following example.

POST https://appstore-sdk.amazon.com/version/1.0/auth/o2/token?
grant_type=authorization_code
&code=SplxlOBezQQYbYS6WxSbIA
&client_id=foodev
&client_secret=foosecret

The following table describes the access token request parameters.

Access token response

To access customer data, you must provide an access token to the Appstore SDK Get User Profile API. An access token is an alphanumeric code 350 characters or more in length, with a maximum size of 2048 bytes. Access tokens begin with the characters Atza|.

Response parameters are encoded using the application/json media type. For more information, see RFC4627. The following is an example response from an access token request.

{
"access_token":"Atza|IQEBLjAsAhRmHjNgHpi0U-Dme37rR6CuUpSR...",
"token_type":"bearer",
"expires_in":3600,
"refresh_token":"Atzr|IQEBLzAtAhRPpMJxdwVz2Nn6f2y-tpJX2DeX..."
}

The following table describes the access token response parameters.

An access token is a bearer token and can be used by another client. For more information, see The OAuth 2.0 Authorization Framework: Bearer Token Usage.

Access token errors

For some errors, the authorization service may return an HTTP 401 (Unauthorized) status code. This includes cases where the client passed the client_id and client_secret values in the authorization header and the client could not be authenticated.

The following table describes the error parameters in an unsuccessful response.

The following error codes can be returned as the value for error.

Get User Profile API

The Appstore SDK provides the Get User Profile REST API to get user profile data. This section describes the request, response, and errors.

User profile request

To access authorized user profile data, use the Get User Profile API to submit the access token to the Appstore. The Get User Profile API uses an HTTPS GET request and takes the access token that you received from the Get Access Token API as it's only parameter.

The following example shows a GET request to obtain user profile data.

GET https://appstore-sdk.amazon.com/version/1.0/user/profile?
access_token=Atza|IQEBLjAsAhRmHjNgHpi0U-Dme37rR6CuUpSR...

User profile response

If your access token is valid, you receive the customer's profile data as an HTTP response in JSON, as shown in this example.

{
"user_id": "amznl.account.K2LI23KL2LK2",
"email":"mhashimoto-04@plaxo.com",
"name" :"Mork Hashimoto",
"postal_code": "98052"
}

If there is a problem fulfilling your profile request, you receive an HTTP error and might receive a JSON payload with more information, as shown in the following example.

{
"error": "machine-readable error code",
"error_description": "human-readable error description",
"request_id": "bef0c2f8-e292-4l96-8c95-8833fbd559df"
}

The following table describes the error codes that can be returned in an unsuccessful user profile request.

Flow diagram

The following diagram shows the code flow for Quick Subscribe with one-click account information sharing.

Open/Close text description  

Best practices for account setup

Follow these best practices for setting up customer accounts.

• If UserProfileAccessConsentStatus has the value CONSENTED in the getUserData() response, do the following:
  • Fetch the user information from the Appstore SDK Get User Profile API. Use this information to create a login account with a temporary password. Sign the customer in to the app without requesting a password reset or additional details from the customer.
  • Later, ask the customer to reset the password through email.
• If UserProfileAccessConsentStatus is UNAVAILABLE, use the default app sign-up experience for the customer.

Step 8: Test Quick Subscribe with LAT

To test Quick Subscribe with Live App Testing (LAT), first configure Quick Subscribe for LAT in the Developer Console using the steps in Configure Quick Subscribe in the Developer Console. You can configure Quick Subscribe for LAT only, or configure it for both your live and LAT apps, as shown in the following image.

If you choose to configure Quick Subscribe for LAT only, you can later promote the configuration to your live app by selecting Actions > Promote to Live as shown in the following image.

If you configured Quick Subscribe for your LAT app differently than your live app, a TEST label appears in the quick subscription details for the LAT app as shown in the following image.

You can test the Quick Subscribe flow through the Amazon retail website or on a Fire device. When you start a live app test, you can send invitations to testers. Testers receive an email with a link to the Amazon website with the LAT version of the app.

Test Quick Subscribe on the website

From the LAT invitation email, select the Amazon website for your marketplace. On the app detail page, select the subscription option, which appears as a paid option for a subscription term, such as $20.00 monthly. Then, select a device to deliver to, and click Get App.

Test Quick Subscribe on the device

To get started with testing Quick Subscribe on the device, you can use the LAT invitation email or the device notification.

To test from the LAT invitation:

1. Use the link in the invitation email to go to the app detail page on the Amazon website.
2. Select the App Only option.
3. In the Deliver to: drop-down menu, select Cloud Only.
4. Click Get App.
5. On a Fire TV device associated with the Amazon account, click the icon for Your Apps & Channels (the icon appears on the navigation bar as three squares and a plus sign).
6. Find the LAT version of your app, which has a TEST banner on the app icon. You might need to click App Library to see the app.
7. Select the app icon to open the app detail page on the device.
8. Select Subscription Options and download the app.

To test from the notification:

After you send a LAT invite, the test devices associated with the tester email receive a notification. If you open the notification when it appears, you are taken to the LAT app detail page. This notification appears for 5-10 seconds. If you miss the notification when it first appears, you can click the settings icon (the gear icon) and select Notifications to see it. You can then read the notification and go to the app detail page. Select Subscription Options and download the app.

Related topics

• Quick Subscribe Test Cases

Last updated: Dec 18, 2024