Method: monetization.subscriptions.basePlans.deactivate
Stay organized with collections
Save and categorize content based on your preferences.
Deactivates a base plan. Once deactivated, the base plan will become unavailable to new subscribers, but existing subscribers will maintain their subscription
HTTP request
POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:deactivate
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
packageName |
string
Required. The parent app (package name) of the base plan to deactivate.
|
productId |
string
Required. The parent subscription (ID) of the base plan to deactivate.
|
basePlanId |
string
Required. The unique base plan ID of the base plan 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 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.
[null,null,["Last updated 2025-05-21 UTC."],[[["\u003cp\u003eDeactivates a base plan, making it unavailable to new subscribers while existing subscribers retain access.\u003c/p\u003e\n"],["\u003cp\u003eRequires a POST request to a specific endpoint with package name, product ID, and base plan ID as path parameters.\u003c/p\u003e\n"],["\u003cp\u003eOptionally accepts a request body specifying the latency tolerance for the product update propagation.\u003c/p\u003e\n"],["\u003cp\u003eUpon success, the response returns a Subscription object.\u003c/p\u003e\n"],["\u003cp\u003eNeeds authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/androidpublisher\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document details the process for deactivating a base plan for an Android app subscription. The key action is a `POST` HTTP request to a specified URL, including `packageName`, `productId`, and `basePlanId` as required path parameters. The request body can optionally include a `latencyTolerance` field. Upon successful deactivation, existing subscribers maintain their subscriptions. The response body returns an instance of `Subscription`. This operation requires the `https://www.googleapis.com/auth/androidpublisher` OAuth scope.\n"],null,["# Method: monetization.subscriptions.basePlans.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 base plan. Once deactivated, the base plan will become unavailable to new subscribers, but existing subscribers will maintain their subscription\n\n### HTTP request\n\n`POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}: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 base plan to deactivate. |\n| `productId` | `string` Required. The parent subscription (ID) of the base plan to deactivate. |\n| `basePlanId` | `string` Required. The unique base plan ID of the base plan 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 [Subscription](/android-publisher/api-ref/rest/v3/monetization.subscriptions#Subscription).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/androidpublisher`"]]