Method: monetization.subscriptions.batchGet
Stay organized with collections
Save and categorize content based on your preferences.
Reads one or more subscriptions.
HTTP request
GET https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions:batchGet
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
packageName |
string
Required. The parent app (package name) for which the subscriptions should be retrieved. Must be equal to the packageName field on all the requests.
|
Query parameters
| Parameters |
productIds[] |
string
Required. A list of up to 100 subscription product IDs to retrieve. All the IDs must be different.
|
Request body
The request body must be empty.
Response body
Response message for subscriptions.batchGet endpoint.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"subscriptions": [
{
object (Subscription)
}
]
} |
| Fields |
subscriptions[] |
object (Subscription)
The list of requested subscriptions, in the same order as the request.
|
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.
[null,null,["Last updated 2025-05-21 UTC."],[[["\u003cp\u003eRetrieves details for one or more app subscriptions using their product IDs.\u003c/p\u003e\n"],["\u003cp\u003eRequires providing the app's package name and a list of subscription product IDs.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of subscriptions corresponding to the provided product IDs, if found.\u003c/p\u003e\n"],["\u003cp\u003eUses the \u003ccode\u003eGET\u003c/code\u003e HTTP method and requires the \u003ccode\u003ehttps://www.googleapis.com/auth/androidpublisher\u003c/code\u003e authorization scope.\u003c/p\u003e\n"],["\u003cp\u003eRequest body should be empty.\u003c/p\u003e\n"]]],["This document details retrieving multiple subscriptions via a `GET` request to `https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions:batchGet`. The `packageName` is a mandatory path parameter. A `productIds[]` query parameter, containing up to 100 unique subscription IDs, is also required. The request body must be empty. A successful response includes a JSON object with a `subscriptions[]` field that lists requested subscriptions in the order they were requested. The operation requires the `androidpublisher` OAuth scope.\n"],null,["# Method: monetization.subscriptions.batchGet\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.BatchGetSubscriptionsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReads one or more subscriptions.\n\n### HTTP request\n\n`GET https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions:batchGet`\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 retrieved. Must be equal to the packageName field on all the requests. |\n\n### Query parameters\n\n| Parameters ||\n|----------------|-------------------------------------------------------------------------------------------------------------|\n| `productIds[]` | `string` Required. A list of up to 100 subscription product IDs to retrieve. All the IDs must be different. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for subscriptions.batchGet endpoint.\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) } ] } ``` |\n\n| Fields ||\n|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `subscriptions[]` | `object (`[Subscription](/android-publisher/api-ref/rest/v3/monetization.subscriptions#Subscription)`)` The list of requested subscriptions, in the same order as the request. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/androidpublisher`"]]