Method: monetization.subscriptions.basePlans.activate
Stay organized with collections Save and categorize content based on your preferences.
Activates a base plan. Once activated, base plans will be available to new subscribers.
HTTP request
POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:activate
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
packageName | string
Required. The parent app (package name) of the base plan to activate. |
productId | string
Required. The parent subscription (ID) of the base plan to activate. |
basePlanId | string
Required. The unique base plan ID of the base plan to activate. |
Request body
The request body contains data with the following structure:
| Fields |
latencyTolerance | enum (ProductUpdateLatencyTolerance)
Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive. |
Response body
If successful, the response body contains an instance of Subscription.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/androidpublisher
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-21 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-21 UTC."],[[["\u003cp\u003eActivates a specified base plan, making it available to new subscribers within a parent subscription and app package.\u003c/p\u003e\n"],["\u003cp\u003eRequires a POST request to a specific endpoint, providing the package name, product ID, and base plan ID in the URL path.\u003c/p\u003e\n"],["\u003cp\u003eOptionally accepts a request body to define the latency tolerance for the product update propagation.\u003c/p\u003e\n"],["\u003cp\u003eUpon successful activation, the response returns details of the updated subscription.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/androidpublisher\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document outlines how to activate a base plan for subscriptions via an HTTP POST request. The request targets a specific application (`packageName`), subscription (`productId`), and base plan (`basePlanId`). The request body can optionally include a `latencyTolerance` field, defaulting to latency-sensitive. Upon success, the response returns a `Subscription` instance. Authorization requires the `https://www.googleapis.com/auth/androidpublisher` OAuth scope. The URL structure utilizes gRPC Transcoding.\n"],null,["- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nActivates a base plan. Once activated, base plans will be available to new subscribers.\n\nHTTP request\n\n`POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:activate`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\n| Parameters ||\n|---------------|--------------------------------------------------------------------------------|\n| `packageName` | `string` Required. The parent app (package name) of the base plan to activate. |\n| `productId` | `string` Required. The parent subscription (ID) of the base plan to activate. |\n| `basePlanId` | `string` Required. The unique base plan ID of the base plan to activate. |\n\nRequest body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------|\n| ``` { \"latencyTolerance\": enum (/android-publisher/api-ref/rest/v3/ProductUpdateLatencyTolerance) } ``` |\n\n| Fields ||\n|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `latencyTolerance` | `enum (`[ProductUpdateLatencyTolerance](/android-publisher/api-ref/rest/v3/ProductUpdateLatencyTolerance)`)` Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive. |\n\nResponse body\n\nIf successful, the response body contains an instance of [Subscription](/android-publisher/api-ref/rest/v3/monetization.subscriptions#Subscription).\n\nAuthorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/androidpublisher`"]]