Parsequerade / docs
Subscription Groups
GET/subscription-groups/{groupId}/subscriptions

Proposed · Extended read design · Adapter not implemented

Request

Routes are relative to your connection. Use a facade API key; the service manages Apple authentication.

cURL
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"

asc.example.com is a placeholder for your deployment. Examples use fictional IDs.

Path parameters

NameTypeDescription
groupIdRequiredstringThe selected resource’s ID.

Query parameters

NameTypeDescription
productIdOptionalstringFilter by product id. Multiple values are comma-separated.
nameOptionalstringFilter by the resource’s name using Apple’s matching behavior. Multiple values are comma-separated.
stateOptionalstringFilter 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
sortOptionalstringComma-separated sort keys. Prefix a key with - for descending order. Only the values below are supported. Multiple values are comma-separated.
Valuesname, -name
fieldsOptionalstringComma-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
limitOptional · Default 50integerNumber of items per page, from 1 to 200.
cursorOptionalstringOpaque nextCursor from a previous response. Keep the route, connection, filters, and ordering unchanged.

Response

A page of flat objects, with an opaque continuation cursor.

200 · application/json
{
  "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

NameTypeDescription
itemsobject[]The current page of plain resource objects. An empty collection returns [].
nextCursorstring | nullOpaque continuation token, or null when the collection is complete. Pass it back as cursor.

Each item

NameTypeDescription
idstringApple’s resource ID. Keep this string unchanged when addressing a resource.
namestringThe resource’s name. An app’s localized name is read from its app-info localization.
productIdstringThe product identifier configured in App Store Connect.
familySharablebooleanWhether the purchase is available through Family Sharing.
statestringThe 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
subscriptionPeriodstringThe subscription’s renewal period, using Apple’s enum values.
ValuesONE_WEEK, ONE_MONTH, TWO_MONTHS, THREE_MONTHS, SIX_MONTHS, ONE_YEAR
reviewNotestringThe review note attached to this purchase or subscription.
groupLevelintegerThe subscription’s position within its subscription group.
multiSeatStatusstringThe multi seat status value reported by Apple for this resource.
ValuesENABLED, DISABLED
marketSettingsstring[]The market settings value reported by Apple for this resource.
ValuesAPPLE_SCHOOL, APP_STORE, APPLE_BUSINESS
appStoreReviewScreenshotIdOptional linkagestring | nullID of the related app store review screenshot. Present only when Apple supplies linkage; related objects are not loaded automatically.
groupIdOptional linkagestring | nullID of the related group. Present only when Apple supplies linkage; related objects are not loaded automatically.
promotedPurchaseIdOptional linkagestring | nullID of the related promoted purchase. Present only when Apple supplies linkage; related objects are not loaded automatically.
subscriptionAvailabilityIdOptional linkagestring | nullID 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

HTTPTypeDescription
400invalid_queryUnsupported filter, sort, limit, or cursor.
401unauthorizedMissing or invalid facade API key.
403forbidden / upstream_forbiddenThe caller or configured Apple key cannot read this resource.
404resource_not_foundThe requested resource, parent, or exact locale is absent or outside the caller’s scope.
429rate_limitedA facade or Apple rate limit was reached. Respect Retry-After when returned.
502–504upstream errorApple 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 parameterTypeDescription
productIdqueryfilter[productId]
namequeryfilter[name]
statequeryfilter[state]
sortquerysort
fieldsqueryfields[subscriptions]
limitquerylimit
cursorqueryFacade-owned pagination

Reviewed 2026-10-14 · OpenAPI 4.5.1