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

The SubscriptionOfferCodes API from iOS — 8 operation(s) for subscriptionoffercodes.

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

Tagged areas include SubscriptionOfferCodes. 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 9 operations across 8 paths, and defines 31 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/.

9 operations 8 paths 31 schemas 7 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 SubscriptionOfferCodes 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 9

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

SubscriptionOfferCodes 9
POST
/v1/subscriptionOfferCodes
Create Subscription Offer Codes
subscriptionOfferCodes_createInstance body → 400401403422201409429
GET
/v1/subscriptionOfferCodes/{id}
Get Subscription Offer Codes
subscriptionOfferCodes_getInstance 10 params → 400401403404200429
PATCH
/v1/subscriptionOfferCodes/{id}
Update Subscription Offer Codes
subscriptionOfferCodes_updateInstance 1 param body → 400401403404422200409429
GET
/v1/subscriptionOfferCodes/{id}/relationships/customCodes
List Related Subscription Offer Codes / Custom Codes
subscriptionOfferCodes_customCodes_getToManyRelationship 2 params → 400401403404200429
GET
/v1/subscriptionOfferCodes/{id}/customCodes
List Related Subscription Offer Codes / Custom Codes
subscriptionOfferCodes_customCodes_getToManyRelated 5 params → 400401403404200429
GET
/v1/subscriptionOfferCodes/{id}/relationships/oneTimeUseCodes
List Related Subscription Offer Codes / One Time Use Codes
subscriptionOfferCodes_oneTimeUseCodes_getToManyRelationship 2 params → 400401403404200429
GET
/v1/subscriptionOfferCodes/{id}/oneTimeUseCodes
List Related Subscription Offer Codes / One Time Use Codes
subscriptionOfferCodes_oneTimeUseCodes_getToManyRelated 5 params → 400401403404200429
GET
/v1/subscriptionOfferCodes/{id}/relationships/prices
List Related Subscription Offer Codes / Prices
subscriptionOfferCodes_prices_getToManyRelationship 2 params → 400401403404200429
GET
/v1/subscriptionOfferCodes/{id}/prices
List Related Subscription Offer Codes / Prices
subscriptionOfferCodes_prices_getToManyRelated 7 params → 400401403404200429

Schemas 31

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

SubscriptionOfferCodeOneTimeUseCode
object
5 properties 2 required
SubscriptionOfferDuration
string
SubscriptionOfferMode
string
PagedDocumentLinks
object
3 properties 1 required
SubscriptionOfferCodePrice
object
4 properties 2 required
ResourceLinks
object
1 property
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
SubscriptionOfferCodePricesLinkagesResponse
object
3 properties 2 required
SubscriptionOfferCodeOneTimeUseCodesResponse
object
4 properties 2 required
SubscriptionPricePoint
object
5 properties 2 required
SubscriptionOfferCodeUpdateRequest
object
1 property 1 required
DocumentLinks
object
1 property 1 required
ErrorResponse
object
1 property
RelationshipLinks
object
2 properties
SubscriptionOfferCodeOneTimeUseCodesLinkagesResponse
object
3 properties 2 required
ErrorSourcePointer
object
1 property 1 required
SubscriptionCustomerEligibility
string
OfferCodeEnvironment
string
PagingInformation
object
1 property 1 required
SubscriptionOfferCodePricesResponse
object
4 properties 2 required
SubscriptionOfferCodeCustomCodesLinkagesResponse
object
3 properties 2 required
Subscription
object
5 properties 2 required
SubscriptionOfferEligibility
string
SubscriptionOfferCodeCustomCode
object
5 properties 2 required
SubscriptionOfferCodePriceInlineCreate
object
3 properties 1 required
SubscriptionOfferCodeCustomCodesResponse
object
4 properties 2 required
Territory
object
4 properties 2 required
SubscriptionOfferCode
object
5 properties 2 required
SubscriptionOfferCodeResponse
object
3 properties 2 required
SubscriptionOfferCodeCreateRequest
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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