Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13136338403.5 KB
monetization

Creates a new subscription offer. Only auto-renewing base plans can have subscription offers. The offer state will be DRAFT until it is activated.

post/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers

Path parameters

packageNamestring required

Required. The parent app (package name) for which the offer should be created. Must be equal to the package_name field on the Subscription resource.

productIdstring required

Required. The parent subscription (ID) for which the offer should be created. Must be equal to the product_id field on the SubscriptionOffer resource.

basePlanIdstring required

Required. The parent base plan (ID) for which the offer should be created. Must be equal to the base_plan_id field on the SubscriptionOffer resource.

Query parameters

offerIdstring

Required. The ID to use for the offer. For the requirements on this format, see the documentation of the offer_id field on the SubscriptionOffer resource.

regionsVersion.versionstring

Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in this article. Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.

Request body

offerIdstring

Required. Immutable. Unique ID of this subscription offer. Must be unique within the base plan.

basePlanIdstring

Required. Immutable. The ID of the base plan to which this offer is an extension.

productIdstring

Required. Immutable. The ID of the parent subscription this offer belongs to.

packageNamestring

Required. Immutable. The package name of the app the parent subscription belongs to.

state'STATE_UNSPECIFIED' | 'DRAFT' | 'ACTIVE' | 'INACTIVE'

Output 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.

Response

Successful response