Method: monetization.subscriptions.basePlans.migratePrices

Migrates subscribers who are receiving an historical subscription price to the currently-offered price for the specified region. Requests will cause price change notifications to be sent to users who are currently receiving an historical price older than the supplied timestamp. Subscribers who do not agree to the new price will have their subscription ended at the next renewal.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
packageName

string

Required. Package name of the parent app. Must be equal to the packageName field on the Subscription resource.
productId

string

Required. The ID of the subscription to update. Must be equal to the productId field on the Subscription resource.
basePlanId

string

Required. The unique base plan ID of the base plan to update prices on.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "regionalPriceMigrations": [
    {
      object (RegionalPriceMigrationConfig)
    }
  ],
  "regionsVersion": {
    object (RegionsVersion)
  }
}
Fields
regionalPriceMigrations[]

object (RegionalPriceMigrationConfig)

Required. The regional prices to update.
regionsVersion

object (RegionsVersion)

Required. The version of the available regions being used for the regionalPriceMigrations.

Response body

If successful, the response body is empty.

Authorization scopes

Requires the following OAuth scope:

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

RegionalPriceMigrationConfig

Configuration for a price migration.

JSON representation 
{
  "regionCode": string,
  "oldestAllowedPriceVersionTime": string,
  "priceIncreaseType": enum (PriceIncreaseType)
}
Fields
regionCode

string

Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
oldestAllowedPriceVersionTime

string (Timestamp format)

Required. The cutoff time for historical prices that subscribers can remain paying. Subscribers who are on a price that was created before this cutoff time will be migrated to the currently-offered price. These subscribers will receive a notification that they will be paying a different price. Subscribers who do not agree to the new price will have their subscription ended at the next renewal.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
priceIncreaseType

enum (PriceIncreaseType)

Optional. The behavior the caller wants users to see when there is a price increase during migration. If left unset, the behavior defaults to PRICE_INCREASE_TYPE_OPT_IN. Note that the first opt-out price increase migration for each app must be initiated in Play Console.

PriceIncreaseType

The type of price migration.

Enums
PRICE_INCREASE_TYPE_UNSPECIFIED Unspecified state.
PRICE_INCREASE_TYPE_OPT_IN Price increase will be presented to users on an opt-in basis.
PRICE_INCREASE_TYPE_OPT_OUT Price increase will be presented to users on an opt-out basis.