Subscription Groups
List all subscriptions for a subscription group
Read a page of subscription resources as flat JSON objects.
/subscription-groups/{groupId}/subscriptionsProposed · Extended read design · Adapter not implemented
Request
Routes are relative to your connection. Use a facade API key; the service manages Apple authentication.
BASE='https://asc.example.com/v1/connections/conn_example'
curl --fail-with-body "$BASE/subscription-groups/group_123/subscriptions" \
-H "Authorization: Bearer $ASC_FACADE_KEY"const base = "https://asc.example.com/v1/connections/conn_example";
const response = await fetch(`${base}/subscription-groups/group_123/subscriptions`, {
headers: { Authorization: `Bearer ${process.env.ASC_FACADE_KEY}` }
});
const body = await response.json();
if (!response.ok) {
throw new Error(body.error?.message ?? `HTTP ${response.status}`);
}
console.log(body);import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError
base = "https://asc.example.com/v1/connections/conn_example"
request = Request(
f"{base}/subscription-groups/group_123/subscriptions",
headers={"Authorization": f"Bearer {os.environ['ASC_FACADE_KEY']}"},
)
try:
with urlopen(request) as response:
print(json.load(response))
except HTTPError as error:
detail = json.load(error)
raise RuntimeError(detail["error"]["message"]) from errorasc.example.com is a placeholder for your deployment. Examples use fictional IDs.
Path parameters
| Name | Type | Description |
|---|---|---|
| groupId | string | The selected resource’s ID. |
Query parameters
| Name | Type | Description |
|---|---|---|
| productId | string | Filter by product id. Multiple values are comma-separated. |
| name | string | Filter by the resource’s name using Apple’s matching behavior. Multiple values are comma-separated. |
| state | string | Filter by the current resource state. Version requests map this to Apple’s appVersionState. Multiple values are comma-separated.ValuesMISSING_METADATA, READY_TO_SUBMIT, WAITING_FOR_REVIEW, IN_REVIEW, DEVELOPER_ACTION_NEEDED, PENDING_BINARY_APPROVAL, APPROVED, DEVELOPER_REMOVED_FROM_SALE, REMOVED_FROM_SALE, REJECTED |
| sort | string | Comma-separated sort keys. Prefix a key with - for descending order. Only the values below are supported. Multiple values are comma-separated.Valuesname, -name |
| fields | string | Comma-separated attribute names to return. This selects read fields and does not expand relationships. Multiple values are comma-separated.Valuesname, productId, familySharable, state, subscriptionPeriod, reviewNote, groupLevel, multiSeatStatus, marketSettings |
| limit | integer | Number of items per page, from 1 to 200. |
| cursor | string | Opaque nextCursor from a previous response. Keep the route, connection, filters, and ordering unchanged. |
Response
A page of flat objects, with an opaque continuation cursor.
{
"items": [
{
"id": "subscription_123",
"name": "Example Notes",
"productId": "com.example.notes.pro",
"familySharable": false,
"state": "MISSING_METADATA",
"subscriptionPeriod": "ONE_WEEK"
}
],
"nextCursor": null
}Illustrative response. Optional read fields may be absent or null; unknown enum values are preserved.
Response fields
| Name | Type | Description |
|---|---|---|
| items | object[] | The current page of plain resource objects. An empty collection returns []. |
| nextCursor | string | null | Opaque continuation token, or null when the collection is complete. Pass it back as cursor. |
Each item
| Name | Type | Description |
|---|---|---|
| id | string | Apple’s resource ID. Keep this string unchanged when addressing a resource. |
| name | string | The resource’s name. An app’s localized name is read from its app-info localization. |
| productId | string | The product identifier configured in App Store Connect. |
| familySharable | boolean | Whether the purchase is available through Family Sharing. |
| state | string | The current state reported by Apple for this resource.ValuesMISSING_METADATA, READY_TO_SUBMIT, WAITING_FOR_REVIEW, IN_REVIEW, DEVELOPER_ACTION_NEEDED, PENDING_BINARY_APPROVAL, APPROVED, DEVELOPER_REMOVED_FROM_SALE, REMOVED_FROM_SALE, REJECTED |
| subscriptionPeriod | string | The subscription’s renewal period, using Apple’s enum values.ValuesONE_WEEK, ONE_MONTH, TWO_MONTHS, THREE_MONTHS, SIX_MONTHS, ONE_YEAR |
| reviewNote | string | The review note attached to this purchase or subscription. |
| groupLevel | integer | The subscription’s position within its subscription group. |
| multiSeatStatus | string | The multi seat status value reported by Apple for this resource.ValuesENABLED, DISABLED |
| marketSettings | string[] | The market settings value reported by Apple for this resource.ValuesAPPLE_SCHOOL, APP_STORE, APPLE_BUSINESS |
| appStoreReviewScreenshotId | string | null | ID of the related app store review screenshot. Present only when Apple supplies linkage; related objects are not loaded automatically. |
| groupId | string | null | ID of the related group. Present only when Apple supplies linkage; related objects are not loaded automatically. |
| promotedPurchaseId | string | null | ID of the related promoted purchase. Present only when Apple supplies linkage; related objects are not loaded automatically. |
| subscriptionAvailabilityId | string | null | ID of the related subscription availability. Present only when Apple supplies linkage; related objects are not loaded automatically. |
Behavior
- A nested resource must belong to the selected parent and the configured connection. The adapter validates ownership before returning data.
Pagination
Pass nextCursor back as cursor with the same filters and ordering. Stop when it is null. Each request returns one bounded page; the service never reports a capped or incomplete traversal as a complete collection.
Errors
| HTTP | Type | Description |
|---|---|---|
| 400 | invalid_query | Unsupported filter, sort, limit, or cursor. |
| 401 | unauthorized | Missing or invalid facade API key. |
| 403 | forbidden / upstream_forbidden | The caller or configured Apple key cannot read this resource. |
| 404 | resource_not_found | The requested resource, parent, or exact locale is absent or outside the caller’s scope. |
| 429 | rate_limited | A facade or Apple rate limit was reached. Respect Retry-After when returned. |
| 502–504 | upstream error | Apple authentication, response parsing, availability, or timeout failure; this is not an empty result. |
Apple mapping
Upstream route and translation
The adapter calls GET /v1/subscriptionGroups/{id}/subscriptions. Read Apple’s original endpoint ↗
Flatten Apple’s attributes into each resource object. Expose supplied singleton linkage as IDs, with no automatic relationship traversal. Read access does not make these fields writable.
| Facade parameter | Type | Description |
|---|---|---|
| productId | query | filter[productId] |
| name | query | filter[name] |
| state | query | filter[state] |
| sort | query | sort |
| fields | query | fields[subscriptions] |
| limit | query | limit |
| cursor | query | Facade-owned pagination |
Reviewed 2026-10-14 · OpenAPI 4.5.1