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

GET

monetization

Lists all offers under a given subscription.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://androidpublisher.googleapis.com//androidpublisher/v3/applications//subscriptions//basePlans//offers'

Response Example

{
    "nextPageToken": "string",
    "subscriptionOffers": [
        {
            "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 subscriptions should be read.

productId

string

required

Required. The parent subscription (ID) for which the offers should be read.

basePlanId

string

required

Required. The parent base plan (ID) for which the offers should be read. May be specified as '-' to read all offers under a subscription.

Query Params

pageSize

integer

optional

The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken

string

optional

A page token, received from a previous ListSubscriptionsOffers call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSubscriptionOffers must match the call that provided the page token.

Responses

🟢200Successful response

application/json

Body

Response message for ListSubscriptionOffers.

nextPageToken

string

optional

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

subscriptionOffers

array[object (SubscriptionOffer) {10}]

optional

The subscription offers from the specified subscription.

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.

otherRegionsConfig

object (OtherRegionsSubscriptionOfferConfig)

optional

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

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.

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.

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

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.

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

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

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