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

The SubscriptionPromotionalOffers API from iOS — 4 operation(s) for subscriptionpromotionaloffers.

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

Tagged areas include SubscriptionPromotionalOffers. 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 6 operations across 4 paths, and defines 22 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/.

6 operations 4 paths 22 schemas 1 DELETE3 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 SubscriptionPromotionalOffers 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 6

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

SubscriptionPromotionalOffers 6
POST
/v1/subscriptionPromotionalOffers
Create Subscription Promotional Offers
subscriptionPromotionalOffers_createInstance body → 400401403422201409429
GET
/v1/subscriptionPromotionalOffers/{id}
Get Subscription Promotional Offers
subscriptionPromotionalOffers_getInstance 6 params → 400401403404200429
PATCH
/v1/subscriptionPromotionalOffers/{id}
Update Subscription Promotional Offers
subscriptionPromotionalOffers_updateInstance 1 param body → 400401403404422200409429
DELETE
/v1/subscriptionPromotionalOffers/{id}
Delete Subscription Promotional Offers
subscriptionPromotionalOffers_deleteInstance 1 param → 400401403404204429
GET
/v1/subscriptionPromotionalOffers/{id}/relationships/prices
List Related Subscription Promotional Offers / Prices
subscriptionPromotionalOffers_prices_getToManyRelationship 2 params → 400401403404200429
GET
/v1/subscriptionPromotionalOffers/{id}/prices
List Related Subscription Promotional Offers / Prices
subscriptionPromotionalOffers_prices_getToManyRelated 7 params → 400401403404200429

Schemas 22

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

PagedDocumentLinks
object
3 properties 1 required
SubscriptionOfferMode
string
SubscriptionOfferDuration
string
ResourceLinks
object
1 property
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
SubscriptionPromotionalOffer
object
5 properties 2 required
SubscriptionPricePoint
object
5 properties 2 required
DocumentLinks
object
1 property 1 required
SubscriptionPromotionalOfferResponse
object
3 properties 2 required
SubscriptionPromotionalOfferPricesResponse
object
4 properties 2 required
ErrorResponse
object
1 property
SubscriptionPromotionalOfferPrice
object
4 properties 2 required
SubscriptionPromotionalOfferCreateRequest
object
2 properties 1 required
SubscriptionPromotionalOfferUpdateRequest
object
2 properties 1 required
RelationshipLinks
object
2 properties
ErrorSourcePointer
object
1 property 1 required
SubscriptionPromotionalOfferPricesLinkagesResponse
object
3 properties 2 required
PagingInformation
object
1 property 1 required
Subscription
object
5 properties 2 required
Territory
object
4 properties 2 required
SubscriptionPromotionalOfferPriceInlineCreate
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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