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 Subscriptions. 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.0.1, 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.
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
GET
/v1/subscriptions/{id}
Get Subscriptions
PATCH
/v1/subscriptions/{id}
Update Subscriptions
DELETE
/v1/subscriptions/{id}
Delete Subscriptions
GET
/v1/subscriptions/{id}/relationships/appStoreReviewScreenshot
Get Related Subscriptions / App Store Review Screenshot
GET
/v1/subscriptions/{id}/appStoreReviewScreenshot
Get Related Subscriptions / App Store Review Screenshot
GET
/v1/subscriptions/{id}/relationships/images
List Related Subscriptions / Images
GET
/v1/subscriptions/{id}/images
List Related Subscriptions / Images
GET
/v1/subscriptions/{id}/relationships/introductoryOffers
List Related Subscriptions / Introductory Offers
DELETE
/v1/subscriptions/{id}/relationships/introductoryOffers
Remove Related Subscriptions / Introductory Offers
GET
/v1/subscriptions/{id}/introductoryOffers
List Related Subscriptions / Introductory Offers
GET
/v1/subscriptions/{id}/relationships/offerCodes
List Related Subscriptions / Offer Codes
GET
/v1/subscriptions/{id}/offerCodes
List Related Subscriptions / Offer Codes
GET
/v1/subscriptions/{id}/relationships/pricePoints
List Related Subscriptions / Price Points
GET
/v1/subscriptions/{id}/pricePoints
List Related Subscriptions / Price Points
GET
/v1/subscriptions/{id}/relationships/prices
List Related Subscriptions / Prices
DELETE
/v1/subscriptions/{id}/relationships/prices
Remove Related Subscriptions / Prices
GET
/v1/subscriptions/{id}/prices
List Related Subscriptions / Prices
GET
/v1/subscriptions/{id}/relationships/promotedPurchase
Get Related Subscriptions / Promoted Purchase
GET
/v1/subscriptions/{id}/promotedPurchase
Get Related Subscriptions / Promoted Purchase
GET
/v1/subscriptions/{id}/relationships/promotionalOffers
List Related Subscriptions / Promotional Offers
GET
/v1/subscriptions/{id}/promotionalOffers
List Related Subscriptions / Promotional Offers
GET
/v1/subscriptions/{id}/relationships/subscriptionAvailability
Get Related Subscriptions / Subscription Availability
GET
/v1/subscriptions/{id}/subscriptionAvailability
Get Related Subscriptions / Subscription Availability
GET
/v1/subscriptions/{id}/relationships/subscriptionLocalizations
List Related Subscriptions / Subscription Localizations
GET
/v1/subscriptions/{id}/subscriptionLocalizations
List Related Subscriptions / Subscription Localizations
GET
/v1/subscriptions/{id}/relationships/winBackOffers
List Related Subscriptions / Win Back Offers
GET
/v1/subscriptions/{id}/winBackOffers
List Related Subscriptions / Win Back Offers
Schemas 73
The contract defines 73 schemas that model the data the API accepts and returns. The most detailed are InAppPurchaseV2 (5 properties), SubscriptionAvailability (5 properties), SubscriptionPrice (5 properties), SubscriptionOfferCodeOneTimeUseCode (5 properties). Each schema is shown below with its type and property counts.
SubscriptionOfferCode
object
5 properties
2 required
SubscriptionAppStoreReviewScreenshot
object
5 properties
2 required
SubscriptionPrice
object
5 properties
2 required
ImageAsset
object
3 properties
PagedDocumentLinks
object
3 properties
1 required
SubscriptionOfferMode
string
SubscriptionOfferDuration
string
SubscriptionOfferCodePrice
object
4 properties
2 required
ResourceLinks
object
1 property
SubscriptionOfferCodeOneTimeUseCode
object
5 properties
2 required
SubscriptionPricePointsResponse
object
4 properties
2 required
PromotedPurchaseResponse
object
3 properties
2 required
ErrorSourceParameter
object
1 property
1 required
ErrorLinks
object
2 properties
SubscriptionPromotionalOffer
object
5 properties
2 required
SubscriptionOfferCodesResponse
object
4 properties
2 required
SubscriptionWinBackOffersLinkagesResponse
object
3 properties
2 required
AppMediaAssetState
object
3 properties
SubscriptionOfferCodesLinkagesResponse
object
3 properties
2 required
csv
string
WinBackOfferPrice
object
4 properties
2 required
SubscriptionPricePoint
object
5 properties
2 required
SubscriptionGroup
object
5 properties
2 required
DocumentLinks
object
1 property
1 required
Territory
object
4 properties
2 required
UploadOperation
object
5 properties
WinBackOffer
object
5 properties
2 required
IntegerRange
object
2 properties
SubscriptionAppStoreReviewScreenshotLinkageResponse
object
2 properties
2 required
ErrorResponse
object
1 property
SubscriptionCreateRequest
object
1 property
1 required
SubscriptionPricesLinkagesResponse
object
3 properties
2 required
SubscriptionPricesLinkagesRequest
object
1 property
1 required
SubscriptionImage
object
5 properties
2 required
SubscriptionPriceInlineCreate
object
4 properties
1 required
SubscriptionPromotionalOfferPrice
object
4 properties
2 required
SubscriptionPricesResponse
object
4 properties
2 required
SubscriptionImagesResponse
object
4 properties
2 required
SubscriptionIntroductoryOffersLinkagesRequest
object
1 property
1 required
RelationshipLinks
object
2 properties
SubscriptionIntroductoryOffersLinkagesResponse
object
3 properties
2 required
PromotedPurchase
object
5 properties
2 required
SubscriptionSubscriptionLocalizationsLinkagesResponse
object
3 properties
2 required
SubscriptionResponse
object
3 properties
2 required
InAppPurchaseV2
object
5 properties
2 required
SubscriptionAvailability
object
5 properties
2 required
SubscriptionImagesLinkagesResponse
object
3 properties
2 required
SubscriptionIntroductoryOfferInlineCreate
object
4 properties
2 required
ErrorSourcePointer
object
1 property
1 required
SubscriptionCustomerEligibility
string
SubscriptionIntroductoryOffersResponse
object
4 properties
2 required
SubscriptionPromotionalOffersResponse
object
4 properties
2 required
SubscriptionPromotionalOffersLinkagesResponse
object
3 properties
2 required
SubscriptionPromotionalOfferInlineCreate
object
4 properties
2 required
PagingInformation
object
1 property
1 required
SubscriptionLocalizationsResponse
object
4 properties
2 required
OfferCodeEnvironment
string
SubscriptionSubscriptionAvailabilityLinkageResponse
object
2 properties
2 required
SubscriptionUpdateRequest
object
2 properties
1 required
SubscriptionAvailabilityResponse
object
3 properties
2 required
Subscription
object
5 properties
2 required
SubscriptionIntroductoryOffer
object
5 properties
2 required
InAppPurchaseState
string
SubscriptionOfferEligibility
string
SubscriptionOfferCodeCustomCode
object
5 properties
2 required
AppMediaStateError
object
2 properties
WinBackOffersResponse
object
4 properties
2 required
InAppPurchaseType
string
SubscriptionAppStoreReviewScreenshotResponse
object
3 properties
2 required
SubscriptionPromotedPurchaseLinkageResponse
object
2 properties
2 required
SubscriptionPricePointsLinkagesResponse
object
3 properties
2 required
HttpHeader
object
2 properties
SubscriptionLocalization
object
5 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from iOS 12
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
#Subscriptions