Method: monetization.subscriptions.basePlans.deactivate

  • The deactivate method is used to make a base plan unavailable to new subscribers while existing subscribers retain their subscription.

  • The HTTP request uses a POST method with a URL specifying the package name, product ID, and base plan ID.

  • Required path parameters include packageName, productId, and basePlanId.

  • The optional request body includes latencyTolerance to specify the propagation latency for the update.

  • A successful response returns a Subscription object.

  • Authorization requires the https://www.googleapis.com/auth/androidpublisher OAuth scope.

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:

JSON representation 
{
  "latencyTolerance": enum (ProductUpdateLatencyTolerance)
}
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