List all subscription groups for an app
Get a list of subscription groups for a specific app.
URL
GET https://api.appstoreconnect.apple.com/v1/apps/{id}/subscriptionGroupsPath Parameters
| Name | Type | Description |
|---|---|---|
id Required | string | An opaque resource ID that uniquely identifies the resource. Obtain the app resource ID from the List apps response. |
Query Parameters
| Name | Type | Description |
|---|---|---|
fields[subscriptionGroupLocalizations] Optional | [string] | Additional fields to include for each subscription group localization resource returned by the response. |
fields[subscriptionGroups] Optional | [string] | Additional fields to include for each subscription group resource returned by the response. |
fields[subscriptions] Optional | [string] | Additional fields to include for each subscription resource returned by the response. |
filter[referenceName] Optional | [string] | Filter the returned subscription groups by reference name. |
filter[subscriptions.state] Optional | [string] | Filter the returned subscription groups by subscriptions state. |
include Optional | [string] | The relationship data to include in the response. |
limit Optional | integer | The maximum number of subscription group resources to return. |
limit[subscriptionGroupLocalizations] Optional | integer | The maximum number of related subscription group localizations resources to return. |
limit[subscriptions] Optional | integer | The maximum number of related subscriptions resources to return. |
sort Optional | [string] | Attributes by which to sort. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | SubscriptionGroupsResponse | |
| 400 | Bad Request Content-Type: application/json | ErrorResponse | |
| 401 | Unauthorized Content-Type: application/json | ErrorResponse | |
| 403 | Forbidden Content-Type: application/json | ErrorResponse | |
| 404 | Not Found Content-Type: application/json | ErrorResponse | |
| 429 | Content-Type: application/json | ErrorResponse |