Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

iOS SubscriptionGroups API

The SubscriptionGroups API from iOS — 6 operation(s) for subscriptiongroups.

iOS SubscriptionGroups API is one of 199 APIs that iOS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SubscriptionGroups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and release notes.

This API exposes 8 operations across 6 paths, and defines 39 schemas. It is described by OpenAPI 3.0.1, at version 4.3.1.

Requests are made against a single base URL, https://api.appstoreconnect.apple.com/.

8 operations 6 paths 39 schemas 1 DELETE5 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
4.3.1
Base URL
https://api.appstoreconnect.apple.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

iOS SubscriptionGroups API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (itc-bearer-token). By default, every request must be authenticated.

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 1 DELETE, 5 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

SubscriptionGroups 8
POST
/v1/subscriptionGroups
Create Subscription Groups
subscriptionGroups_createInstance body → 400401403422201409429
GET
/v1/subscriptionGroups/{id}
Get Subscription Groups
subscriptionGroups_getInstance 7 params → 400401403404200429
PATCH
/v1/subscriptionGroups/{id}
Update Subscription Groups
subscriptionGroups_updateInstance 1 param body → 400401403404422200409429
DELETE
/v1/subscriptionGroups/{id}
Delete Subscription Groups
subscriptionGroups_deleteInstance 1 param → 400401403404204429
GET
/v1/subscriptionGroups/{id}/relationships/subscriptionGroupLocalizations
List Related Subscription Groups / Subscription Group Localizations
subscriptionGroups_subscriptionGroupLocalizations_getToManyRelationship 2 params → 400401403404200429
GET
/v1/subscriptionGroups/{id}/subscriptionGroupLocalizations
List Related Subscription Groups / Subscription Group Localizations
subscriptionGroups_subscriptionGroupLocalizations_getToManyRelated 5 params → 400401403404200429
GET
/v1/subscriptionGroups/{id}/relationships/subscriptions
List Related Subscription Groups / Subscriptions
subscriptionGroups_subscriptions_getToManyRelationship 2 params → 400401403404200429
GET
/v1/subscriptionGroups/{id}/subscriptions
List Related Subscription Groups / Subscriptions
subscriptionGroups_subscriptions_getToManyRelated 26 params → 400401403404200429

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are SubscriptionPrice (5 properties), SubscriptionOfferCode (5 properties), SubscriptionIntroductoryOffer (5 properties), Subscription (5 properties). Each schema is shown below with its type and property counts.

SubscriptionPrice
object
5 properties 2 required
SubscriptionAppStoreReviewScreenshot
object
5 properties 2 required
ImageAsset
object
3 properties
PagedDocumentLinks
object
3 properties 1 required
SubscriptionOfferMode
string
SubscriptionOfferDuration
string
SubscriptionGroupCreateRequest
object
1 property 1 required
ResourceLinks
object
1 property
SubscriptionsResponse
object
4 properties 2 required
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
SubscriptionPromotionalOffer
object
5 properties 2 required
SubscriptionGroupSubscriptionGroupLocalizationsLinkagesResponse
object
3 properties 2 required
AppMediaAssetState
object
3 properties
SubscriptionGroup
object
5 properties 2 required
DocumentLinks
object
1 property 1 required
UploadOperation
object
5 properties
SubscriptionGroupUpdateRequest
object
1 property 1 required
WinBackOffer
object
5 properties 2 required
IntegerRange
object
2 properties
ErrorResponse
object
1 property
SubscriptionImage
object
5 properties 2 required
RelationshipLinks
object
2 properties
PromotedPurchase
object
5 properties 2 required
SubscriptionGroupLocalizationsResponse
object
4 properties 2 required
SubscriptionAvailability
object
5 properties 2 required
ErrorSourcePointer
object
1 property 1 required
SubscriptionCustomerEligibility
string
SubscriptionGroupLocalization
object
5 properties 2 required
PagingInformation
object
1 property 1 required
SubscriptionGroupResponse
object
3 properties 2 required
Subscription
object
5 properties 2 required
SubscriptionIntroductoryOffer
object
5 properties 2 required
SubscriptionOfferEligibility
string
AppMediaStateError
object
2 properties
SubscriptionGroupSubscriptionsLinkagesResponse
object
3 properties 2 required
SubscriptionOfferCode
object
5 properties 2 required
HttpHeader
object
2 properties
SubscriptionLocalization
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ios-subscriptiongroups-api-openapi.yml Raw ↑

Other APIs iOS publishes across the network.

App Store Server API
App Store Server Notifications
Apple Push Notification Service (APNs)
DeviceCheck and App Attest
Sign in with Apple REST API
Apple Music API
Wallet / PassKit Web Service
iOS AccessibilityDeclarations API
iOS Actors API
iOS AgeRatingDeclarations API
iOS AlternativeDistributionDomains API
iOS AlternativeDistributionKeys API