Method: monetization.subscriptions.basePlans.offers.deactivate
Stay organized with collections
Save and categorize content based on your preferences.
Deactivates a subscription offer. Once deactivated, existing subscribers will maintain their subscription, but the offer will become unavailable to new subscribers.
HTTP request
POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}:deactivate
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
packageName |
string
Required. The parent app (package name) of the offer to deactivate.
|
productId |
string
Required. The parent subscription (ID) of the offer to deactivate.
|
basePlanId |
string
Required. The parent base plan (ID) of the offer to deactivate.
|
offerId |
string
Required. The unique offer ID of the offer to deactivate.
|
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\u003eDeactivates a subscription offer, preventing new subscriptions while existing ones remain active.\u003c/p\u003e\n"],["\u003cp\u003eSends a POST request to the specified URL with necessary path parameters like package name, product ID, base plan ID, and offer ID.\u003c/p\u003e\n"],["\u003cp\u003eOptionally includes a request body specifying the latency tolerance for the update.\u003c/p\u003e\n"],["\u003cp\u003eUpon success, returns a SubscriptionOffer object in the response body.\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 API call deactivates a subscription offer for an Android app. It uses a `POST` request to a specific URL, incorporating the app's package name, subscription ID, base plan ID, and offer ID as required path parameters. The request body, in JSON format, allows for specifying `latencyTolerance`. A successful request returns data of `SubscriptionOffer`, and requires the `https://www.googleapis.com/auth/androidpublisher` OAuth scope for authorization. The deactivation makes the offer unavailable to new subscribers.\n"],null,["# Method: monetization.subscriptions.basePlans.offers.deactivate\n\n- [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\nDeactivates a subscription offer. Once deactivated, existing subscribers will maintain their subscription, but the offer will become unavailable to new subscribers.\n\n### HTTP request\n\n`POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}:deactivate`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|------------------------------------------------------------------------------|\n| `packageName` | `string` Required. The parent app (package name) of the offer to deactivate. |\n| `productId` | `string` Required. The parent subscription (ID) of the offer to deactivate. |\n| `basePlanId` | `string` Required. The parent base plan (ID) of the offer to deactivate. |\n| `offerId` | `string` Required. The unique offer ID of the offer to deactivate. |\n\n### Request 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\n### Response body\n\nIf successful, the response body contains an instance of [SubscriptionOffer](/android-publisher/api-ref/rest/v3/monetization.subscriptions.basePlans.offers#SubscriptionOffer).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/androidpublisher`"]]