How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

iOS Subscriptions API

The Subscriptions API from iOS — 24 operation(s) for subscriptions.

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

Tagged areas include Subscription. 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 28 operations across 24 paths, and defines 73 schemas. It is described by OpenAPI 3.2.0, at version 4.3.1.

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

28 operations 24 paths 73 schemas 3 DELETE23 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

iOS Subscriptions 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 28

Across 24 paths, the API surfaces 28 operations — 3 DELETE, 23 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 28
POST
/v1/subscriptions
Create Subscriptions
subscriptions_createInstance body → 400401403422201409429
GET
/v1/subscriptions/{id}
Get Subscriptions
subscriptions_getInstance 21 params → 400401403404200429
PATCH
/v1/subscriptions/{id}
Update Subscriptions
subscriptions_updateInstance 1 param body → 400401403404422200409429
DELETE
/v1/subscriptions/{id}
Delete Subscriptions
subscriptions_deleteInstance 1 param → 400401403404204429
GET
/v1/subscriptions/{id}/relationships/appStoreReviewScreenshot
Get Related Subscriptions / App Store Review Screenshot
subscriptions_appStoreReviewScreenshot_getToOneRelationship 1 param → 400401403404200429
GET
/v1/subscriptions/{id}/appStoreReviewScreenshot
Get Related Subscriptions / App Store Review Screenshot
subscriptions_appStoreReviewScreenshot_getToOneRelated 4 params → 400401403404200429
GET
/v1/subscriptions/{id}/relationships/images
List Related Subscriptions / Images
subscriptions_images_getToManyRelationship 2 params → 400401403404200429
GET
/v1/subscriptions/{id}/images
List Related Subscriptions / Images
subscriptions_images_getToManyRelated 5 params → 400401403404200429
GET
/v1/subscriptions/{id}/relationships/introductoryOffers
List Related Subscriptions / Introductory Offers
subscriptions_introductoryOffers_getToManyRelationship 2 params → 400401403404200429
DELETE
/v1/subscriptions/{id}/relationships/introductoryOffers
Remove Related Subscriptions / Introductory Offers
subscriptions_introductoryOffers_deleteToManyRelationship 1 param body → 400401403404422409204429
GET
/v1/subscriptions/{id}/introductoryOffers
List Related Subscriptions / Introductory Offers
subscriptions_introductoryOffers_getToManyRelated 8 params → 400401403404200429
GET
/v1/subscriptions/{id}/relationships/offerCodes
List Related Subscriptions / Offer Codes
subscriptions_offerCodes_getToManyRelationship 2 params → 400401403404200429
GET
/v1/subscriptions/{id}/offerCodes
List Related Subscriptions / Offer Codes
subscriptions_offerCodes_getToManyRelated 12 params → 400401403404200429
GET
/v1/subscriptions/{id}/relationships/pricePoints
List Related Subscriptions / Price Points
subscriptions_pricePoints_getToManyRelationship 2 params → 400401403404200429
GET
/v1/subscriptions/{id}/pricePoints
List Related Subscriptions / Price Points
subscriptions_pricePoints_getToManyRelated 6 params → 400401403404200429
GET
/v1/subscriptions/{id}/relationships/prices
List Related Subscriptions / Prices
subscriptions_prices_getToManyRelationship 2 params → 400401403404200429
DELETE
/v1/subscriptions/{id}/relationships/prices
Remove Related Subscriptions / Prices
subscriptions_prices_deleteToManyRelationship 1 param body → 400401403404422409204429
GET
/v1/subscriptions/{id}/prices
List Related Subscriptions / Prices
subscriptions_prices_getToManyRelated 8 params → 400401403404200429
GET
/v1/subscriptions/{id}/relationships/promotedPurchase
Get Related Subscriptions / Promoted Purchase
subscriptions_promotedPurchase_getToOneRelationship 1 param → 400401403404200429
GET
/v1/subscriptions/{id}/promotedPurchase
Get Related Subscriptions / Promoted Purchase
subscriptions_promotedPurchase_getToOneRelated 5 params → 400401403404200429
GET
/v1/subscriptions/{id}/relationships/promotionalOffers
List Related Subscriptions / Promotional Offers
subscriptions_promotionalOffers_getToManyRelationship 2 params → 400401403404200429
GET
/v1/subscriptions/{id}/promotionalOffers
List Related Subscriptions / Promotional Offers
subscriptions_promotionalOffers_getToManyRelated 8 params → 400401403404200429
GET
/v1/subscriptions/{id}/relationships/subscriptionAvailability
Get Related Subscriptions / Subscription Availability
subscriptions_subscriptionAvailability_getToOneRelationship 1 param → 400401403404200429
GET
/v1/subscriptions/{id}/subscriptionAvailability
Get Related Subscriptions / Subscription Availability
subscriptions_subscriptionAvailability_getToOneRelated 5 params → 400401403404200429
GET
/v1/subscriptions/{id}/relationships/subscriptionLocalizations
List Related Subscriptions / Subscription Localizations
subscriptions_subscriptionLocalizations_getToManyRelationship 2 params → 400401403404200429
GET
/v1/subscriptions/{id}/subscriptionLocalizations
List Related Subscriptions / Subscription Localizations
subscriptions_subscriptionLocalizations_getToManyRelated 5 params → 400401403404200429
GET
/v1/subscriptions/{id}/relationships/winBackOffers
List Related Subscriptions / Win Back Offers
subscriptions_winBackOffers_getToManyRelationship 2 params → 400401403404200429
GET
/v1/subscriptions/{id}/winBackOffers
List Related Subscriptions / Win Back Offers
subscriptions_winBackOffers_getToManyRelated 6 params → 400401403404200429

Schemas 73

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

WinBackOfferPrice
object
4 properties 2 required
InAppPurchaseV2
object
5 properties 2 required
SubscriptionAvailability
object
5 properties 2 required
SubscriptionOfferCodesResponse
object
4 properties 2 required
SubscriptionSubscriptionAvailabilityLinkageResponse
object
2 properties 2 required
SubscriptionUpdateRequest
object
2 properties 1 required
Territory
object
4 properties 2 required
ErrorSourcePointer
object
1 property 1 required
SubscriptionPrice
object
5 properties 2 required
csv
string
SubscriptionIntroductoryOffersLinkagesRequest
object
1 property 1 required
SubscriptionPricePointsLinkagesResponse
object
3 properties 2 required
SubscriptionIntroductoryOfferInlineCreate
object
4 properties 2 required
SubscriptionCreateRequest
object
1 property 1 required
SubscriptionSubscriptionLocalizationsLinkagesResponse
object
3 properties 2 required
IntegerRange
object
2 properties
SubscriptionAppStoreReviewScreenshotResponse
object
3 properties 2 required
SubscriptionAppStoreReviewScreenshotLinkageResponse
object
2 properties 2 required
SubscriptionOfferCodesLinkagesResponse
object
3 properties 2 required
SubscriptionPricePointsResponse
object
4 properties 2 required
SubscriptionPromotionalOfferInlineCreate
object
4 properties 2 required
SubscriptionOfferEligibility
string
SubscriptionOfferMode
string
ErrorResponse
object
1 property
WinBackOffer
object
5 properties 2 required
SubscriptionLocalizationsResponse
object
4 properties 2 required
SubscriptionAvailabilityResponse
object
3 properties 2 required
SubscriptionOfferCodeCustomCode
object
5 properties 2 required
RelationshipLinks
object
2 properties
SubscriptionPromotionalOffersResponse
object
4 properties 2 required
Subscription
object
5 properties 2 required
SubscriptionIntroductoryOffersLinkagesResponse
object
3 properties 2 required
SubscriptionPromotionalOffersLinkagesResponse
object
3 properties 2 required
SubscriptionLocalization
object
5 properties 2 required
SubscriptionIntroductoryOffer
object
5 properties 2 required
SubscriptionCustomerEligibility
string
SubscriptionPromotedPurchaseLinkageResponse
object
2 properties 2 required
SubscriptionPricesLinkagesResponse
object
3 properties 2 required
DocumentLinks
object
1 property 1 required
AppMediaAssetState
object
3 properties
ImageAsset
object
3 properties
PagingInformation
object
1 property 1 required
ResourceLinks
object
1 property
SubscriptionPromotionalOffer
object
5 properties 2 required
SubscriptionPricesResponse
object
4 properties 2 required
SubscriptionPricePoint
object
5 properties 2 required
SubscriptionGroup
object
5 properties 2 required
PromotedPurchaseResponse
object
3 properties 2 required
InAppPurchaseType
string
SubscriptionOfferDuration
string
SubscriptionAppStoreReviewScreenshot
object
5 properties 2 required
SubscriptionOfferCodeOneTimeUseCode
object
5 properties 2 required
SubscriptionImage
object
5 properties 2 required
SubscriptionPromotionalOfferPrice
object
4 properties 2 required
SubscriptionPricesLinkagesRequest
object
1 property 1 required
SubscriptionOfferCodePrice
object
4 properties 2 required
PagedDocumentLinks
object
3 properties 1 required
HttpHeader
object
2 properties
SubscriptionWinBackOffersLinkagesResponse
object
3 properties 2 required
SubscriptionIntroductoryOffersResponse
object
4 properties 2 required
SubscriptionResponse
object
3 properties 2 required
ErrorSourceParameter
object
1 property 1 required
SubscriptionImagesResponse
object
4 properties 2 required
SubscriptionOfferCode
object
5 properties 2 required
PromotedPurchase
object
5 properties 2 required
SubscriptionPriceInlineCreate
object
4 properties 1 required
SubscriptionImagesLinkagesResponse
object
3 properties 2 required
OfferCodeEnvironment
string
ErrorLinks
object
2 properties
UploadOperation
object
5 properties
WinBackOffersResponse
object
4 properties 2 required
InAppPurchaseState
string
AppMediaStateError
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ios-subscriptions-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
Where this information came from

This is an independent, third-party profile of iOS Subscriptions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.