Method: monetization.subscriptions.basePlans.offers.activate

  • This API call activates a subscription offer, making it available to new subscribers.

  • Activating a subscription offer is done using a POST request with specific path parameters including the package name, product ID, base plan ID, and offer ID.

  • The request body can optionally include a latency tolerance setting for the product update.

  • A successful response will contain an instance of SubscriptionOffer.

  • The request requires the https://www.googleapis.com/auth/androidpublisher authorization scope.

Activates a subscription offer. Once activated, subscription offers will be available to new subscribers.

HTTP request

POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}:activate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
packageName

string

Required. The parent app (package name) of the offer to activate.
productId

string

Required. The parent subscription (ID) of the offer to activate.
basePlanId

string

Required. The parent base plan (ID) of the offer to activate.
offerId

string

Required. The unique offer ID of the offer to activate.

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