1. class
  2. Google
  3. \
  4. Service
  5. \
  6. AndroidPublisher
  7. \
  8. Resource
  9. \
  10. MonetizationSubscriptionsBasePlans

MonetizationSubscriptionsBasePlans

class MonetizationSubscriptionsBasePlans extends Resource (View source)

The "basePlans" collection of methods.

Typical usage is:

 $androidpublisherService = new Google\Service\AndroidPublisher(...);
 $basePlans = $androidpublisherService->monetization_subscriptions_basePlans;

Methods

Subscription
activate(string $packageName, string $productId, string $basePlanId, ActivateBasePlanRequest $postBody, array $optParams = [])

Activates a base plan. Once activated, base plans will be available to new subscribers. (basePlans.activate)

BatchMigrateBasePlanPricesResponse
batchMigratePrices(string $packageName, string $productId, BatchMigrateBasePlanPricesRequest $postBody, array $optParams = [])

Batch variant of the MigrateBasePlanPrices endpoint. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput. (basePlans.batchMigratePrices)

BatchUpdateBasePlanStatesResponse
batchUpdateStates(string $packageName, string $productId, BatchUpdateBasePlanStatesRequest $postBody, array $optParams = [])

Activates or deactivates base plans across one or multiple subscriptions. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput. (basePlans.batchUpdateStates)

Subscription
deactivate(string $packageName, string $productId, string $basePlanId, DeactivateBasePlanRequest $postBody, array $optParams = [])

Deactivates a base plan. Once deactivated, the base plan will become unavailable to new subscribers, but existing subscribers will maintain their subscription (basePlans.deactivate)

delete(string $packageName, string $productId, string $basePlanId, array $optParams = [])

Deletes a base plan. Can only be done for draft base plans. This action is irreversible. (basePlans.delete)

MigrateBasePlanPricesResponse
migratePrices(string $packageName, string $productId, string $basePlanId, MigrateBasePlanPricesRequest $postBody, array $optParams = [])

Migrates subscribers from one or more legacy price cohorts to the current price. Requests result in Google Play notifying affected subscribers. Only up to 250 simultaneous legacy price cohorts are supported.

Details

at line 55
Subscription activate(string $packageName, string $productId, string $basePlanId, ActivateBasePlanRequest $postBody, array $optParams = [])

Activates a base plan. Once activated, base plans will be available to new subscribers. (basePlans.activate)

Parameters

string $packageName

Required. The parent app (package name) of the base plan to activate.
string $productId

Required. The parent subscription (ID) of the base plan to activate.
string $basePlanId

Required. The unique base plan ID of the base plan to activate.
ActivateBasePlanRequest $postBody
array $optParams

Optional parameters.

Return Value

Subscription

Exceptions

Exception

at line 77
BatchMigrateBasePlanPricesResponse batchMigratePrices(string $packageName, string $productId, BatchMigrateBasePlanPricesRequest $postBody, array $optParams = [])

Batch variant of the MigrateBasePlanPrices endpoint. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput. (basePlans.batchMigratePrices)

Parameters

string $packageName

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

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.
BatchMigrateBasePlanPricesRequest $postBody
array $optParams

Optional parameters.

Return Value

BatchMigrateBasePlanPricesResponse

Exceptions

Exception

at line 99
BatchUpdateBasePlanStatesResponse batchUpdateStates(string $packageName, string $productId, BatchUpdateBasePlanStatesRequest $postBody, array $optParams = [])

Activates or deactivates base plans across one or multiple subscriptions. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput. (basePlans.batchUpdateStates)

Parameters

string $packageName

Required. The parent app (package name) of the updated base plans.
string $productId

Required. The product ID of the parent subscription, if all updated base plans belong to the same subscription. If this batch update spans multiple subscriptions, set this field to "-". Must be set.
BatchUpdateBasePlanStatesRequest $postBody
array $optParams

Optional parameters.

Return Value

BatchUpdateBasePlanStatesResponse

Exceptions

Exception

at line 121
Subscription deactivate(string $packageName, string $productId, string $basePlanId, DeactivateBasePlanRequest $postBody, array $optParams = [])

Deactivates a base plan. Once deactivated, the base plan will become unavailable to new subscribers, but existing subscribers will maintain their subscription (basePlans.deactivate)

Parameters

string $packageName

Required. The parent app (package name) of the base plan to deactivate.
string $productId

Required. The parent subscription (ID) of the base plan to deactivate.
string $basePlanId

Required. The unique base plan ID of the base plan to deactivate.
DeactivateBasePlanRequest $postBody
array $optParams

Optional parameters.

Return Value

Subscription

Exceptions

Exception

at line 140
delete(string $packageName, string $productId, string $basePlanId, array $optParams = [])

Deletes a base plan. Can only be done for draft base plans. This action is irreversible. (basePlans.delete)

Parameters

string $packageName

Required. The parent app (package name) of the base plan to delete.
string $productId

Required. The parent subscription (ID) of the base plan to delete.
string $basePlanId

Required. The unique offer ID of the base plan to delete.
array $optParams

Optional parameters.

Exceptions

Exception

at line 163
MigrateBasePlanPricesResponse migratePrices(string $packageName, string $productId, string $basePlanId, MigrateBasePlanPricesRequest $postBody, array $optParams = [])

Migrates subscribers from one or more legacy price cohorts to the current price. Requests result in Google Play notifying affected subscribers. Only up to 250 simultaneous legacy price cohorts are supported.

(basePlans.migratePrices)

Parameters

string $packageName

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

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

Required. The unique base plan ID of the base plan to update prices on.
MigrateBasePlanPricesRequest $postBody
array $optParams

Optional parameters.

Return Value

MigrateBasePlanPricesResponse

Exceptions

Exception