Method: monetization.subscriptions.basePlans.batchMigratePrices

  • The batchMigratePrices endpoint is a batch variant of the basePlans.migratePrices endpoint for updating subscription base plan prices.

  • To maximize update throughput, set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT.

  • The HTTP request uses a POST method to the specified URL with package and product IDs as path parameters.

  • The request body contains an array of up to 100 MigrateBasePlanPricesRequest objects, each updating a different base plan.

  • The response body contains an array of MigrateBasePlanPricesResponse objects, one for each requested price migration.

Batch variant of the basePlans.migratePrices endpoint.

Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
packageName

string

Required. The parent app (package name) for which the subscriptions should be created or updated. Must be equal to the packageName field on all the Subscription resources.
productId

string

Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this batch update spans multiple subscriptions, set this field to "-". Must be set.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requests": [
    {
      object (MigrateBasePlanPricesRequest)
    }
  ]
}
Fields
requests[]

object (MigrateBasePlanPricesRequest)

Required. Up to 100 price migration requests. All requests must update different base plans.

Response body

Response message for basePlans.batchMigratePrices.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "responses": [
    {
      object (MigrateBasePlanPricesResponse)
    }
  ]
}
Fields
responses[]

object (MigrateBasePlanPricesResponse)

Contains one response per requested price migration, in the same order as the request.

Authorization scopes

Requires the following OAuth scope:

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

MigrateBasePlanPricesRequest

Request message for basePlans.migratePrices.

JSON representation 
{
  "packageName": string,
  "productId": string,
  "basePlanId": string,
  "regionalPriceMigrations": [
    {
      object (RegionalPriceMigrationConfig)
    }
  ],
  "regionsVersion": {
    object (RegionsVersion)
  },
  "latencyTolerance": enum (ProductUpdateLatencyTolerance)
}
Fields
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.
regionalPriceMigrations[]

object (RegionalPriceMigrationConfig)

Required. The regional prices to update.
regionsVersion

object (RegionsVersion)

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

enum (ProductUpdateLatencyTolerance)

Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.