Skip to main content

offers

Overview

Nameoffers
TypeResource
Idgoogledevelopers.androidpublisher.offers

Fields

NameDatatypeDescription
productIdstringRequired. Immutable. The ID of the parent subscription this offer belongs to.
statestringOutput only. The current state of this offer. Can be changed using Activate and Deactivate actions. NB: the base plan state supersedes this state, so an active offer may not be available if the base plan is not active.
basePlanIdstringRequired. Immutable. The ID of the base plan to which this offer is an extension.
offerTagsarrayList of up to 20 custom tags specified for this offer, and returned to the app through the billing library.
packageNamestringRequired. Immutable. The package name of the app the parent subscription belongs to.
phasesarrayRequired. The phases of this subscription offer. Must contain at least one entry, and may contain at most five. Users will always receive all these phases in the specified order. Phases may not be added, removed, or reordered after initial creation.
otherRegionsConfigobjectConfiguration for any new locations Play may launch in specified on a subscription offer.
regionalConfigsarrayRequired. The region-specific configuration of this offer. Must contain at least one entry.
offerIdstringRequired. Immutable. Unique ID of this subscription offer. Must be unique within the base plan.
targetingobjectDefines the rule a user needs to satisfy to receive this offer.

Methods

NameAccessible byRequired ParamsDescription
monetization_subscriptions_basePlans_offers_getSELECTbasePlanId, offerId, packageName, productIdReads a single offer
monetization_subscriptions_basePlans_offers_listSELECTbasePlanId, packageName, productIdLists all offers under a given subscription.
monetization_subscriptions_basePlans_offers_createINSERTbasePlanId, packageName, productIdCreates a new subscription offer. Only auto-renewing base plans can have subscription offers. The offer state will be DRAFT until it is activated.
monetization_subscriptions_basePlans_offers_deleteDELETEbasePlanId, offerId, packageName, productIdDeletes a subscription offer. Can only be done for draft offers. This action is irreversible.
monetization_subscriptions_basePlans_offers_activateEXECbasePlanId, offerId, packageName, productIdActivates a subscription offer. Once activated, subscription offers will be available to new subscribers.
monetization_subscriptions_basePlans_offers_deactivateEXECbasePlanId, offerId, packageName, productIdDeactivates a subscription offer. Once deactivated, existing subscribers will maintain their subscription, but the offer will become unavailable to new subscribers.
monetization_subscriptions_basePlans_offers_patchEXECbasePlanId, offerId, packageName, productIdUpdates an existing subscription offer.