/androidpublisher/v3/applications/{packageName}/subscriptions

GET

monetization

Lists all subscriptions under a given app.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

{
    "nextPageToken": "string",
    "subscriptions": [
        {
            "archived": true,
            "basePlans": [
                {
                    "autoRenewingBasePlanType": {
                        "billingPeriodDuration": "string",
                        "gracePeriodDuration": "string",
                        "legacyCompatible": true,
                        "prorationMode": "SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED",
                        "resubscribeState": "RESUBSCRIBE_STATE_UNSPECIFIED"
                    },
                    "basePlanId": "string",
                    "offerTags": [
                        {
                            "tag": "string"
                        }
                    ],
                    "otherRegionsConfig": {
                        "eurPrice": {
                            "currencyCode": "string",
                            "nanos": 0,
                            "units": "string"
                        },
                        "newSubscriberAvailability": true,
                        "usdPrice": {
                            "currencyCode": "string",
                            "nanos": 0,
                            "units": "string"
                        }
                    },
                    "prepaidBasePlanType": {
                        "billingPeriodDuration": "string",
                        "timeExtension": "TIME_EXTENSION_UNSPECIFIED"
                    },
                    "regionalConfigs": [
                        {
                            "newSubscriberAvailability": true,
                            "price": {
                                "currencyCode": "string",
                                "nanos": 0,
                                "units": "string"
                            },
                            "regionCode": "string"
                        }
                    ],
                    "state": "STATE_UNSPECIFIED"
                }
            ],
            "listings": [
                {
                    "benefits": [
                        "string"
                    ],
                    "description": "string",
                    "languageCode": "string",
                    "title": "string"
                }
            ],
            "packageName": "string",
            "productId": "string",
            "taxAndComplianceSettings": {
                "eeaWithdrawalRightType": "WITHDRAWAL_RIGHT_TYPE_UNSPECIFIED",
                "taxRateInfoByRegionCode": {
                    "property1": {
                        "eligibleForStreamingServiceTaxRate": true,
                        "taxTier": "TAX_TIER_UNSPECIFIED"
                    },
                    "property2": {
                        "eligibleForStreamingServiceTaxRate": true,
                        "taxTier": "TAX_TIER_UNSPECIFIED"
                    }
                }
            }
        }
    ]
}

Request

Path Params

packageName

string

required

Required. The parent app (package name) for which the subscriptions should be read.

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 ListSubscriptions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSubscriptions must match the call that provided the page token.

showArchived

string

optional

Whether archived subscriptions should be included in the response. Defaults to false.

Responses

🟢200Successful response

application/json

Body

Response message for ListSubscriptions.

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.

subscriptions

array[object (Subscription) {6}]

optional

The subscriptions from the specified app.

archived

boolean

read-onlyoptional

Output only. Whether this subscription is archived. Archived subscriptions are not available to any subscriber any longer, cannot be updated, and are not returned in list requests unless the show archived flag is passed in.

basePlans

array[object (BasePlan) {7}]

optional

The set of base plans for this subscription. Represents the prices and duration of the subscription if no other offers apply.

listings

array[object (SubscriptionListing) {4}]

optional

Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app.

packageName

string

optional

Immutable. Package name of the parent app.

productId

string

optional

Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length.

taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

optional

Details about taxes and legal compliance.

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

/androidpublisher/v3/applications/{packageName}/pricing:convertRegionPrices

/androidpublisher/v3/applications/{packageName}/subscriptions