Migrate to Google Play Billing Library 6 from versions 4 or 5

Stay organized with collections Save and categorize content based on your preferences.

This topic describes how to migrate from Google Play Billing Library 4 or 5 to Google Play Billing Library 6 and how to use new subscription capabilities.

For a full list of the changes in version 6.0.0, refer to the release notes.

Overview

Google Play Billing Library 6 builds on the new subscription features introduced in version 5 and adds a few more improvements. These features allow you to sell subscriptions in more ways, reducing operational costs by eliminating the need to create and manage an ever-increasing number of SKUs.

For more information about the new features introduced with Play Billing Library 5, see Recent changes to subscriptions in Play Console.

Backward-compatible Play Billing Library upgrade

All existing subscription products were automatically converted to this new paradigm as part of the May 2022 release of Play Billing Library 5 and the new subscriptions platform. This means that you don't have to make any subscription product configuration changes to have a catalog that is compatible with the new versions of the Play Billing Library. For more information on how subscription SKUs were converted into backward-compatible subscriptions, see the Working with older subscriptions section in the Play Console Help article.

Older versions of your app still work

If you have a backward-compatible subscription catalog, all existing versions of your app should still work as intended for those products. One-time product purchases should also continue working without issues in older versions.

Versions of your app using deprecated methods (for example, querySkuDetailsAsync()) won't be able to sell any base plans or offers that are not backward compatible. You can read about backward-compatible offers in the relevant Play Console Help Center article.

Upgrade to Play Billing Library 5 or 6

Play Billing Library 5 and 6 include the deprecated methods querySkuDetailsAsync and BillingFlowParams.Builder.setSkuDetails that takes SkuDetails as a billing flow parameter. This means that you can gradually move to Play Billing Library 6 by planning different stages of migration.

As a first step to migration, you can just update the library version, leave your catalog and backend as they are, and test your app while it still uses the deprecated methods. If you are not using queryPurchases, launchPriceChangeFlow, or setVrPurchaseFlow, it should still work as intended. Afterwards, you can iterate to fully adopt the new subscription features released in May 2022.

If you have previously adopted these features with a Google Play Billing Library 5 migration, you can proceed directly to the sections labeled Update Google Play Billing Library and Change a user's subscription purchases. If you are starting from an earlier version or didn't fully adopt the new features yet, you can read the full migration steps that follow to learn how to adopt them.

Full migration steps

Create new subscriptions in your backend product catalog

Using the Play Developer Console or the Play Developer API, you can now configure a single subscription with multiple base plans, each with multiple offers. Subscription offers have flexible pricing models and eligibility options. You can create offers across the subscription lifecycle using a variety of auto-renewing and prepaid plans.

We recommend creating new products following the entity structure in the new subscription platform for your Play Billing Library 6 integration before migrating your app. You can consolidate duplicate products in your old catalog representing the same entitlement benefits under a single subscription and use base plan and offer configurations to represent all the options that you want to offer. For more information about this recommendation, see the Working with older subscriptions section of the Play Console Help article.

We recommend that you don't modify the converted subscription products after the May 2022 release; you should leave them as they are to be sold with the versions of your app using deprecated methods (for example, querySkuDetailsAsync()) without introducing changes that could affect these older builds.

The conversion process made the subscription products that were in your catalog before May 2022 read-only to avoid accidental changes that could result in issues with your existing integration. Making changes to these subscriptions is possible, but there would be implications that could affect your frontend and backend integrations:

• On the frontend, app versions using querySkuDetailsAsync() to obtain subscription product details can only sell backward-compatible base plans and offers, and there can only be one backward-compatible base plan and offer combination, so if you add new plans or offers to the converted subscriptions, the new additional base plans or offers won’t be able to be sold on these older versions of your app.

• On the backend, if you edit your converted subscriptions in the Play Console UI, you won’t be able to manage them with the inappproducts endpoint, if you were calling the endpoint for this purpose. You should also migrate to the new subscription purchase status endpoint (purchases.subscriptionsv2.get) to manage purchases for these subscriptions, as the old purchase status endpoint (purchases.subscriptions.get) only returns the data necessary to handle backward-compatible base plans and offers purchases. Read the Manage subscription purchase status section for more information.

Manage your backend subscription catalog with the new API

If you manage your subscription product catalog automatically with the Google Play Developer API, you need to use the new subscription product definition endpoints to create and manage subscriptions, base plans, and offers. Read the May 2022 subscription features guide to learn more about the product catalog API changes for this release.

To migrate an automatic product catalog management module for Google Play Billing subscriptions, replace the inappproducts API with the new Subscription Publishing API to manage and publish your subscription catalog. There are three new endpoints:

• Monetization.subscriptions to manage subscription products.
• Monetization.basePlans to manage base plans for subscriptions.
• Monetization.offers to manage offers for base plans.

These new endpoints have all the necessary functionality to leverage all the new capabilities in your catalog: base plan and offer tags, regional targeting, prepaid plans, and more.

You should still use the inappproducts API to manage your in-app product catalog for one-time purchase products.

Versions of your app using deprecated methods (for example, querySkuDetailsAsync()) won’t be able to sell any base plans or offers that are not backward compatible. You can read about backward-compatible offers here.

Update Google Play Billing Library

Once you have created your new subscription products catalog, you can migrate your app to Google Billing Library 5. Replace the existing Play Billing Library dependency with the updated version to your app’s build.gradle file.

dependencies {
    def billingVersion = "6.0.0"

    implementation "com.android.billingclient:billing:$billingVersion"
}

Your project should build right away, even if you haven’t modified any calls to methods—Play Billing Library 6 is backward compatible. The concept of a SKU is considered deprecated, but still present to make porting apps a simpler, more incremental process.

Initialize the Billing Client and establish a connection to Google Play

The first steps to launch purchases from an Android app remain the same:

• Initialize the Billing Client
• Establish a connection to Google Play

Show products available to buy

To obtain all offers a user is eligible to purchase:

• Replace SkuDetailsParams with QueryProductDetailsParams
• Switch the BillingClient.querySkuDetailsAsync() call to use BillingClient.queryProductDetailsAsync()

Note that query results are now ProductDetails instead of SkuDetails. Each ProductDetails item contains the information about the product (ID, title, type, and so on). For subscription products, ProductDetails contains a List<ProductDetails.SubscriptionOfferDetails>, which is the list of the subscription offer details. For one-time purchase products, ProductDetails contains a ProductDetails.OneTimePurchaseOfferDetails. These can be used to decide which offers to show to the users.

The following example shows how your app might look before and after making these changes:

Before

val skuList = ArrayList<String>()

skuList.add("up_basic_sub")

val params = SkuDetailsParams.newBuilder()

params.setSkusList(skuList).setType(BillingClient.SkuType.SUBS).build()

billingClient.querySkuDetailsAsync(params) {
    billingResult,
    skuDetailsList ->
    // Process the result
}

List<String> skuList = new ArrayList<>();

skuList.add("up_basic_sub");

SkuDetailsParams.Builder params = SkuDetailsParams.newBuilder();

params.setSkusList(skuList).setType(SkuType.SUBS).build();

billingClient.querySkuDetailsAsync(params,
    new SkuDetailsResponseListener() {
        @Override
        public void onSkuDetailsResponse(BillingResult billingResult,
                List<SkuDetails> skuDetailsList) {
            // Process the result.
        }
    }
);

After

val productList =
    listOf(
        QueryProductDetailsParams.Product.newBuilder()
            .setProductId("up_basic_sub")
            .setProductType(BillingClient.ProductType.SUBS)
            .build()
    )

val params = QueryProductDetailsParams.newBuilder().setProductList(productList).build()

billingClient.queryProductDetailsAsync(params) {
    billingResult,
    productDetailsList ->
    // Process the result
}

ImmutableList<Product> productList = ImmutableList.of(Product.newBuilder()
                                            .setProductId("up_basic_sub")
                                            .setProductType(ProductType.SUBS)
                                            .build());

QueryProductDetailsParams params = QueryProductDetailsParams.newBuilder()
    .setProductList(productList)
    .build();

billingClient.queryProductDetailsAsync(
        params,
        new ProductDetailsResponseListener() {
                public void onProductDetailsResponse(BillingResult billingResult, List<ProductDetails> productDetailsList) {
                    // Process the result
                }
        }
);

The callback for queryProductDetailsAsync returns a List<ProductDetails>. Each ProductDetails item contains the information about the product (ID, title, type, and so on). The main difference is that subscription products now also contain a List<ProductDetails.SubscriptionOfferDetails> that contains all offers available to the user.

Since previous versions of the Play Billing Library do not support the new objects (subscriptions, base plans, offers, and so on), the new system translates each subscription SKU into a single backward-compatible base plan and offer. Available one-time purchase products are also ported to a ProductDetails object. The offer details of a one-time purchase product can be accessed with the getOneTimePurchaseOfferDetails() method.

Rarely, some devices are unable to support ProductDetails and queryProductDetailsAsync(), usually due to outdated versions of Google Play Services. To ensure proper support for this scenario, call isFeatureSupported() for the PRODUCT_DETAILS feature before calling queryProductDetailsAsync. If the response is OK, the device supports the feature and you can proceed with calling queryProductDetailsAsync(). If the response is FEATURE_NOT_SUPPORTED, you can instead request the available backward-compatible products list with querySkuDetailsAsync(). To learn more about how to use the backward compatibility features, see the May 2022 subscription features guide.

Launch the offer purchase flow

Launching a purchase flow for an offer is very similar to launching a flow for a SKU. To start a purchase request using version 6, do the following:

• Instead of using SkuDetails for BillingFlowParams, use ProductDetailsParams.
• The offer(s) details, such as offer ID, base plan ID, and more can be obtained using the SubscriptionOfferDetails object.

To purchase a product with the user's selected offer, get the offerToken of the selected offer and pass it into the ProductDetailsParams object.

Once you've created a BillingFlowParams object, launching the billing flow with the BillingClient remains the same.

The following example shows how your app might look before and after making these changes:

Before

// An activity reference from which the billing flow will be launched.
val activity : Activity = ...
// Retrieve a value for "skuDetails" by calling querySkuDetailsAsync().
val billingFlowParams = BillingFlowParams.newBuilder()
                            .setSkuDetails(skuDetails)
                            .build()

val billingResult = billingClient.launchBillingFlow(activity, billingFlowParams)

// An activity reference from which the billing flow will be launched.
Activity activity = ...;
// Retrieve a value for "skuDetails" by calling querySkuDetailsAsync().
BillingFlowParams billingFlowParams = BillingFlowParams.newBuilder()
        .setSkuDetails(skuDetails)
        .build();

BillingResult billingResult = billingClient.launchBillingFlow(activity, billingFlowParams)

After

// An activity reference from which the billing flow will be launched.
val activity : Activity = ...;

val productDetailsParamsList = listOf(
    BillingFlowParams.ProductDetailsParams.newBuilder()
        // retrieve a value for "productDetails" by calling queryProductDetailsAsync()
        .setProductDetails(productDetails)
        // For One-time product, "setOfferToken" method shouldn't be called.
        // For subscriptions, to get the offer token corresponding to the selected
        // offer call productDetails.subscriptionOfferDetails?.get(selectedOfferIndex)?.offerToken
        .setOfferToken(selectedOfferToken)
        .build()
)

val billingFlowParams = BillingFlowParams.newBuilder()
    .setProductDetailsParamsList(productDetailsParamsList)
    .build()

// Launch the billing flow
val billingResult = billingClient.launchBillingFlow(activity, billingFlowParams)

// An activity reference from which the billing flow will be launched.
Activity activity = ...;

ImmutableList<ProductDetailsParams> productDetailsParamsList =
    ImmutableList.of(
        ProductDetailsParams.newBuilder()
             // retrieve a value for "productDetails" by calling queryProductDetailsAsync()
            .setProductDetails(productDetails)
            // For one-time products, "setOfferToken" method shouldn't be called.
            // For subscriptions, to get the offer token corresponding to the selected
            // offer call productDetails.getSubscriptionOfferDetails().get(selectedOfferIndex).getOfferToken()
            .setOfferToken(selectedOfferToken)
            .build()
    );

BillingFlowParams billingFlowParams = BillingFlowParams.newBuilder()
    .setProductDetailsParamsList(productDetailsParamsList)
    .build();

// Launch the billing flow
BillingResult billingResult = billingClient.launchBillingFlow(activity, billingFlowParams);

Process the purchases

Processing purchases with Google Play Billing Library 6 remains similar to previous versions.

To pull all active purchases owned by the user and query for new purchases, do the following:

• Instead of passing a BillingClient.SkuType value to queryPurchasesAsync(), pass a QueryPurchasesParams object that contains a BillingClient.ProductType value.

The following example shows how your app might look before and after making these changes:

Before

billingClient.queryPurchasesAsync(BillingClient.SkuType.SUBS) {
    billingResult,
    purchaseList -> {
        // Process the result
    }
}

billingClient.queryPurchasesAsync(
    BillingClient.SkuType.SUBS,
    new PurchasesResponseListener() {
        public void onQueryPurchasesResponse(
                BillingResult billingResult,
                List<Purchase> purchases) {
            // process the result
        }
    }
);

After

billingClient.queryPurchasesAsync(
    QueryPurchasesParams.newBuilder()
        .setProductType(BillingClient.ProductType.SUBS)
        .build()
) { billingResult, purchaseList ->
    // Process the result
}

billingClient.queryPurchasesAsync(
    QueryPurchasesParams.newBuilder().setProductType(ProductType.SUBS).build(),
    new PurchasesResponseListener() {
        public void onQueryPurchasesResponse(
                BillingResult billingResult,
                List<Purchase> purchases) {
            // Process the result
        }
    }
);

The steps to manage out of app purchases and pending transactions haven’t changed.

Manage subscription purchase status with the new API in your backend

You should migrate your subscriptions purchase status management component in your backend to be ready to handle purchases of the new products created in previous steps. Your current subscriptions purchase status management component should work as usual for the converted subscription products you defined before the May 2022 launch, and it should suffice to manage purchases of backward compatible offers, but it doesn’t support any of the new functionality.

You need to implement the new Subscription Purchases API for your subscriptions purchase status management module, which checks the purchase status and manages Play Billing subscription entitlements in your backend. The old version of the API doesn’t return all the necessary details to manage purchases in the new platform. For details on changes from previous versions, see the guide to the May 2022 new subscription features.

You would normally call the Subscription Purchases API every time you receive a SubscriptionNotification Real Time Developer Notification to pull the latest information about the subscription status. You need to replace your calls to purchases.subscriptions.get with the new version of the Subscription Purchases API, purchases.subscriptionsv2.get. There’s a new resource called SubscriptionPurchaseV2 that provides enough information to manage purchase entitlement for subscriptions in the new model.

This new endpoint returns the status for all your subscription products and all your purchases, regardless of the version of the app that sold them and when the product was defined (before or after the May 2022 release), so after the migration you will only need this version of your subscription purchase status management module.

Change a user's subscription purchases

In Play Billing Library 5 and earlier, ProrationMode was used to apply changes to a user's subscription purchases, such as upgrades or downgrades. This has been deprecated and replaced with ReplacementMode in version 6.

Handle subscription price changes

The previously deprecated launchPriceConfirmationFlow API has been removed in Play Billing Library 6. For alternatives, see the price changes guide.

Handle Play Billing Library errors

In Play Billing Library 6, a new NETWORK_ERROR code has been added to indicate problems with the network connection between the user's device and the Google Play system. There were also changes to the codes SERVICE_TIMEOUT and SERVICE_UNAVAILABLE. For more information, see Handle BillingResult response codes.

Handle pending transactions

Starting with version 6.0.0, the Play Billing Library does not create an order ID for pending purchases. For these purchases, the order ID is populated after the purchase is moved to the PURCHASED state. Make sure that your integration only expects an order ID after a transaction is fully completed. You can still use the purchase token for your records. For more information about handling pending purchases, see the Play Billing Library integration guide and the purchase lifecycle management guide.