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 SubscriptionIntroductoryOffers API

The SubscriptionIntroductoryOffers API from iOS — 2 operation(s) for subscriptionintroductoryoffers.

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

Tagged areas include SubscriptionIntroductoryOffers. 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 3 operations across 2 paths, and defines 18 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/.

3 operations 2 paths 18 schemas 1 DELETE1 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 SubscriptionIntroductoryOffers 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 3

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

SubscriptionIntroductoryOffers 3
POST
/v1/subscriptionIntroductoryOffers
Create Subscription Introductory Offers
subscriptionIntroductoryOffers_createInstance body → 400401403422201409429
PATCH
/v1/subscriptionIntroductoryOffers/{id}
Update Subscription Introductory Offers
subscriptionIntroductoryOffers_updateInstance 1 param body → 400401403404422200409429
DELETE
/v1/subscriptionIntroductoryOffers/{id}
Delete Subscription Introductory Offers
subscriptionIntroductoryOffers_deleteInstance 1 param → 400401403404204429

Schemas 18

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

DocumentLinks
object
1 property 1 required
SubscriptionOfferDuration
string
SubscriptionOfferMode
string
SubscriptionIntroductoryOfferResponse
object
3 properties 2 required
RelationshipLinks
object
2 properties
ResourceLinks
object
1 property
SubscriptionIntroductoryOffer
object
5 properties 2 required
Subscription
object
5 properties 2 required
PagingInformation
object
1 property 1 required
ErrorLinks
object
2 properties
ErrorSourceParameter
object
1 property 1 required
ErrorResponse
object
1 property
ErrorSourcePointer
object
1 property 1 required
Territory
object
4 properties 2 required
SubscriptionPricePoint
object
5 properties 2 required
SubscriptionPricePointInlineCreate
object
2 properties 1 required
SubscriptionIntroductoryOfferUpdateRequest
object
1 property 1 required
SubscriptionIntroductoryOfferCreateRequest
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ios-subscriptionintroductoryoffers-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