Method: monetization.subscriptions.basePlans.offers.deactivate

  • This page details how to deactivate a subscription offer using an HTTP POST request to a specific Google Play Developer API endpoint.

  • Deactivating an offer makes it unavailable to new subscribers while existing subscribers retain their subscription.

  • The request requires path parameters such as packageName, productId, basePlanId, and offerId to identify the offer to deactivate.

  • An optional request body allows setting latencyTolerance for the product update propagation.

  • A successful response contains an instance of a SubscriptionOffer object, and the operation requires the https://www.googleapis.com/auth/androidpublisher authorization scope.

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:

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 SubscriptionOffer.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/androidpublisher