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

POST

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://androidpublisher.googleapis.com//androidpublisher/v3/applications//subscriptions//basePlans//offers' \
--header 'Content-Type: application/json' \
--data-raw '{
    "basePlanId": "string",
    "offerId": "string",
    "offerTags": [
        {
            "tag": "string"
        }
    ],
    "otherRegionsConfig": {
        "otherRegionsNewSubscriberAvailability": true
    },
    "packageName": "string",
    "phases": [
        {
            "duration": "string",
            "otherRegionsConfig": {
                "absoluteDiscounts": {
                    "eurPrice": {
                        "currencyCode": "string",
                        "nanos": 0,
                        "units": "string"
                    },
                    "usdPrice": {
                        "currencyCode": "string",
                        "nanos": 0,
                        "units": "string"
                    }
                },
                "otherRegionsPrices": {
                    "eurPrice": {
                        "currencyCode": "string",
                        "nanos": 0,
                        "units": "string"
                    },
                    "usdPrice": {
                        "currencyCode": "string",
                        "nanos": 0,
                        "units": "string"
                    }
                },
                "relativeDiscount": 0
            },
            "recurrenceCount": 0,
            "regionalConfigs": [
                {
                    "absoluteDiscount": {
                        "currencyCode": "string",
                        "nanos": 0,
                        "units": "string"
                    },
                    "price": {
                        "currencyCode": "string",
                        "nanos": 0,
                        "units": "string"
                    },
                    "regionCode": "string",
                    "relativeDiscount": 0
                }
            ]
        }
    ],
    "productId": "string",
    "regionalConfigs": [
        {
            "newSubscriberAvailability": true,
            "regionCode": "string"
        }
    ],
    "targeting": {
        "acquisitionRule": {
            "scope": {
                "specificSubscriptionInApp": "string"
            }
        },
        "upgradeRule": {
            "billingPeriodDuration": "string",
            "oncePerUser": true,
            "scope": {
                "specificSubscriptionInApp": "string"
            }
        }
    }
}'

Response Example

{
    "basePlanId": "string",
    "offerId": "string",
    "offerTags": [
        {
            "tag": "string"
        }
    ],
    "otherRegionsConfig": {
        "otherRegionsNewSubscriberAvailability": true
    },
    "packageName": "string",
    "phases": [
        {
            "duration": "string",
            "otherRegionsConfig": {
                "absoluteDiscounts": {
                    "eurPrice": {
                        "currencyCode": "string",
                        "nanos": 0,
                        "units": "string"
                    },
                    "usdPrice": {
                        "currencyCode": "string",
                        "nanos": 0,
                        "units": "string"
                    }
                },
                "otherRegionsPrices": {
                    "eurPrice": {
                        "currencyCode": "string",
                        "nanos": 0,
                        "units": "string"
                    },
                    "usdPrice": {
                        "currencyCode": "string",
                        "nanos": 0,
                        "units": "string"
                    }
                },
                "relativeDiscount": 0
            },
            "recurrenceCount": 0,
            "regionalConfigs": [
                {
                    "absoluteDiscount": {
                        "currencyCode": "string",
                        "nanos": 0,
                        "units": "string"
                    },
                    "price": {
                        "currencyCode": "string",
                        "nanos": 0,
                        "units": "string"
                    },
                    "regionCode": "string",
                    "relativeDiscount": 0
                }
            ]
        }
    ],
    "productId": "string",
    "regionalConfigs": [
        {
            "newSubscriberAvailability": true,
            "regionCode": "string"
        }
    ],
    "state": "STATE_UNSPECIFIED",
    "targeting": {
        "acquisitionRule": {
            "scope": {
                "specificSubscriptionInApp": "string"
            }
        },
        "upgradeRule": {
            "billingPeriodDuration": "string",
            "oncePerUser": true,
            "scope": {
                "specificSubscriptionInApp": "string"
            }
        }
    }
}

Request

Path Params

packageName

string

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.

productId

string

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.

basePlanId

string

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 Params

offerId

string

optional

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

string

optional

Required. A string representing version of the available regions being used for the specified resource. The current version is 2022/01.

Body Params application/json

A single, temporary offer

basePlanId

string

optional

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

offerId

string

optional

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

offerTags

array[object (OfferTag) {1}]

optional

List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.

tag

string

optional

Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.

otherRegionsConfig

object (OtherRegionsSubscriptionOfferConfig)

optional

The configuration for any new locations Play may launch in the future.

otherRegionsNewSubscriberAvailability

boolean

optional

Whether the subscription offer in any new locations Play may launch in the future. If not specified, this will default to false.

packageName

string

optional

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

phases

array[object (SubscriptionOfferPhase) {4}]

optional

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

duration

string

optional

Required. The duration of a single recurrence of this phase. Specified in ISO 8601 format.

otherRegionsConfig

object (OtherRegionsSubscriptionOfferPhaseConfig)

optional

Pricing information for any new locations Play may launch in.

recurrenceCount

integer <int32>

optional

Required. The number of times this phase repeats. If this offer phase is not free, each recurrence charges the user the price of this offer phase.

regionalConfigs

array[object (RegionalSubscriptionOfferPhaseConfig) {4}]

optional

Required. The region-specific configuration of this offer phase. This list must contain exactly one entry for each region for which the subscription offer has a regional config.

productId

string

optional

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

regionalConfigs

array[object (RegionalSubscriptionOfferConfig) {2}]

optional

Required. The region-specific configuration of this offer. Must contain at least one entry.

newSubscriberAvailability

boolean

optional

Whether the subscription offer in the specified region is available for new subscribers. Existing subscribers will not have their subscription cancelled if this value is set to false. If not specified, this will default to false.

regionCode

string

optional

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

targeting

object (SubscriptionOfferTargeting)

optional

The requirements that users need to fulfil to be eligible for this offer. Represents the requirements that Play will evaluate to decide whether an offer should be returned. Developers may further filter these offers themselves.

acquisitionRule

object (AcquisitionTargetingRule)

optional

Offer targeting rule for new user acquisition.

upgradeRule

object (UpgradeTargetingRule)

optional

Offer targeting rule for upgrading users' existing plans.

Examples

Responses

🟢200Successful response

application/json

Body

A single, temporary offer

basePlanId

string

optional

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

offerId

string

optional

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

offerTags

array[object (OfferTag) {1}]

optional

List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.

tag

string

optional

Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.

otherRegionsConfig

object (OtherRegionsSubscriptionOfferConfig)

optional

The configuration for any new locations Play may launch in the future.

otherRegionsNewSubscriberAvailability

boolean

optional

Whether the subscription offer in any new locations Play may launch in the future. If not specified, this will default to false.

packageName

string

optional

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

phases

array[object (SubscriptionOfferPhase) {4}]

optional

duration

string

optional

Required. The duration of a single recurrence of this phase. Specified in ISO 8601 format.

otherRegionsConfig

object (OtherRegionsSubscriptionOfferPhaseConfig)

optional

Pricing information for any new locations Play may launch in.

recurrenceCount

integer <int32>

optional

Required. The number of times this phase repeats. If this offer phase is not free, each recurrence charges the user the price of this offer phase.

regionalConfigs

array[object (RegionalSubscriptionOfferPhaseConfig) {4}]

optional

Required. The region-specific configuration of this offer phase. This list must contain exactly one entry for each region for which the subscription offer has a regional config.

productId

string

optional

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

regionalConfigs

array[object (RegionalSubscriptionOfferConfig) {2}]

optional

Required. The region-specific configuration of this offer. Must contain at least one entry.

newSubscriberAvailability

boolean

optional

regionCode

string

optional

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

state

enum<string>

read-onlyoptional

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.

Allowed values:

STATE_UNSPECIFIEDDRAFTACTIVEINACTIVE

targeting

object (SubscriptionOfferTargeting)

optional

acquisitionRule

object (AcquisitionTargetingRule)

optional

Offer targeting rule for new user acquisition.

upgradeRule

object (UpgradeTargetingRule)

optional

Offer targeting rule for upgrading users' existing plans.

Modified at 2022-09-11 20:51:56

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

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