Method: accounts.listSubaccounts
Stay organized with collections
Save and categorize content based on your preferences.
List all sub-accounts for a given advanced account. This is a convenience wrapper for the more powerful accounts.list method. This method will produce the same results as calling ListsAccounts with the following filter: relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))
HTTP request
GET https://merchantapi.googleapis.com/accounts/v1/{provider=accounts/*}:listSubaccounts
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
provider |
string
Required. The aggregation service provider. Format: accounts/{accountId}
|
Query parameters
| Parameters |
pageSize |
integer
Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500.
|
pageToken |
string
Optional. A page token, received from a previous accounts.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided in the accounts.list request must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
Response message for the accounts.listSubaccounts method.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"accounts": [
{
object (Account)
}
],
"nextPageToken": string
} |
| Fields |
accounts[] |
object (Account)
The accounts for which the given parent account is an aggregator.
|
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/content
For more information, see the OAuth 2.0 Overview.
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-07-31 UTC.
[null,null,["Last updated 2025-07-31 UTC."],[],[],null,["# Method: accounts.listSubaccounts\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.ListSubAccountsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nList all sub-accounts for a given advanced account. This is a convenience wrapper for the more powerful `accounts.list` method. This method will produce the same results as calling `ListsAccounts` with the following filter: `relationship(providerId={parent} AND service(type=\"ACCOUNT_AGGREGATION\"))`\n\n### HTTP request\n\n`GET https://merchantapi.googleapis.com/accounts/v1/{provider=accounts/*}:listSubaccounts`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|-------------------------------------------------------------------------------------|\n| `provider` | `string` Required. The aggregation service provider. Format: `accounts/{accountId}` |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500. |\n| `pageToken` | `string` Optional. A page token, received from a previous `accounts.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided in the `accounts.list` request must match the call that provided the page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for the `accounts.listSubaccounts` method.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"accounts\": [ { object (/merchant/api/reference/rest/accounts_v1/accounts#Account) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|\n| `accounts[]` | `object (`[Account](/merchant/api/reference/rest/accounts_v1/accounts#Account)`)` The accounts for which the given parent account is an aggregator. |\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/content`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
