Method: monetization.subscriptions.basePlans.offers.activate
Stay organized with collections Save and categorize content based on your preferences.
Activates a subscription offer. Once activated, subscription offers will be available to new subscribers.
HTTP request
POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}:activate
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
packageName | string
Required. The parent app (package name) of the offer to activate. |
productId | string
Required. The parent subscription (ID) of the offer to activate. |
basePlanId | string
Required. The parent base plan (ID) of the offer to activate. |
offerId | string
Required. The unique offer ID of the offer 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 SubscriptionOffer.
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 subscription offer, making it available to new subscribers.\u003c/p\u003e\n"],["\u003cp\u003eRequires a POST request to a specific endpoint with package name, product ID, base plan ID, and offer ID.\u003c/p\u003e\n"],["\u003cp\u003eOptionally, includes latency tolerance for product update propagation within the request body.\u003c/p\u003e\n"],["\u003cp\u003eA successful activation returns a SubscriptionOffer object.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ehttps://www.googleapis.com/auth/androidpublisher\u003c/code\u003e authorization scope.\u003c/p\u003e\n"]]],["This document outlines how to activate a subscription offer via a POST HTTP request to the specified URL, utilizing gRPC Transcoding syntax. The request requires four path parameters: `packageName`, `productId`, `basePlanId`, and `offerId`. The request body optionally includes a `latencyTolerance` field within its JSON structure. A successful request returns a `SubscriptionOffer` instance in the response body. The `https://www.googleapis.com/auth/androidpublisher` OAuth scope is necessary for authorization.\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 subscription offer. Once activated, subscription offers will be available to new subscribers.\n\nHTTP request\n\n`POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}: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 offer to activate. |\n| `productId` | `string` Required. The parent subscription (ID) of the offer to activate. |\n| `basePlanId` | `string` Required. The parent base plan (ID) of the offer to activate. |\n| `offerId` | `string` Required. The unique offer ID of the offer 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 [SubscriptionOffer](/android-publisher/api-ref/rest/v3/monetization.subscriptions.basePlans.offers#SubscriptionOffer).\n\nAuthorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/androidpublisher`"]]