Method: monetization.subscriptions.basePlans.offers.deactivate

  • Deactivates a subscription offer, preventing new subscriptions while existing ones remain active.

  • Sends a POST request to the specified URL with necessary path parameters like package name, product ID, base plan ID, and offer ID.

  • Optionally includes a request body specifying the latency tolerance for the update.

  • Upon success, returns a SubscriptionOffer object in the response body.

  • Requires authorization with the https://www.googleapis.com/auth/androidpublisher 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