Method: monetization.subscriptions.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all subscriptions under a given app.
HTTP request
GET https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions
The URL uses gRPC Transcoding
syntax.
Path parameters
| Parameters |
packageName
|
string
Required. The parent app (package name) for which the subscriptions should be read.
|
Query parameters
| Parameters |
pageSize
|
integer
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
A page token, received from a previous subscriptions.list
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to subscriptions.list
must match the call that provided the page token.
|
showArchived
(deprecated)
|
boolean
Deprecated: subscription archiving is not supported.
|
Request body
The request body must be empty.
Response body
Response message for subscriptions.list.
If successful, the response body contains data with the following structure:
| Fields |
subscriptions[]
|
object ( Subscription
)
The subscriptions from the specified app.
|
nextPageToken
|
string
A token, which can be sent as pageToken
to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
Authorization scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/androidpublisher
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-21 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-21 UTC."],[[["\u003cp\u003eLists all subscriptions under a given app using an HTTP GET request.\u003c/p\u003e\n"],["\u003cp\u003eRequires providing the app's package name as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by page size and using pagination for large result sets.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of subscriptions with details and a token for accessing further pages.\u003c/p\u003e\n"],["\u003cp\u003eNeeds authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/androidpublisher\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document details how to list subscriptions for a given Android application using the Android Publisher API. It uses a `GET` HTTP request to the specified URL, including a required `packageName` path parameter. Optional query parameters like `pageSize` and `pageToken` enable pagination. The request body must be empty. The response includes a list of subscriptions, represented in JSON, and a `nextPageToken` for subsequent pages. This operation requires the `androidpublisher` OAuth scope.\n"],null,["# Method: monetization.subscriptions.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListSubscriptionsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all subscriptions under a given app.\n\n### HTTP request\n\n`GET https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|----------------------------------------------------------------------------------------------|\n| `packageName` | `string` Required. The parent app (package name) for which the subscriptions should be read. |\n\n### Query parameters\n\n| Parameters ||\n|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` 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. |\n| `pageToken` | `string` A page token, received from a previous `subscriptions.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `subscriptions.list` must match the call that provided the page token. |\n| `showArchived` **(deprecated)** | `boolean` Deprecated: subscription archiving is not supported. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for subscriptions.list.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"subscriptions\": [ { object (/android-publisher/api-ref/rest/v3/monetization.subscriptions#Subscription) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|\n| `subscriptions[]` | `object (`[Subscription](/android-publisher/api-ref/rest/v3/monetization.subscriptions#Subscription)`)` The subscriptions from the specified app. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/androidpublisher`"]]
