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

The SubscriptionOfferCodeOneTimeUseCodes API from iOS — 3 operation(s) for subscriptionoffercodeonetimeusecodes.

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

Tagged areas include SubscriptionOfferCodeOneTimeUseCodes. 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 4 operations across 3 paths, and defines 19 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/.

4 operations 3 paths 19 schemas 2 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 SubscriptionOfferCodeOneTimeUseCodes 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 4

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

SubscriptionOfferCodeOneTimeUseCodes 4
POST
/v1/subscriptionOfferCodeOneTimeUseCodes
Create Subscription Offer Code One Time Use Codes
subscriptionOfferCodeOneTimeUseCodes_createInstance body → 400401403422201409429
GET
/v1/subscriptionOfferCodeOneTimeUseCodes/{id}
Get Subscription Offer Code One Time Use Codes
subscriptionOfferCodeOneTimeUseCodes_getInstance 4 params → 400401403404200429
PATCH
/v1/subscriptionOfferCodeOneTimeUseCodes/{id}
Update Subscription Offer Code One Time Use Codes
subscriptionOfferCodeOneTimeUseCodes_updateInstance 1 param body → 400401403404422200409429
GET
/v1/subscriptionOfferCodeOneTimeUseCodes/{id}/values
Get Related Subscription Offer Code One Time Use Codes / Values
subscriptionOfferCodeOneTimeUseCodes_values_getToOneRelated 1 param → 400401403404200429

Schemas 19

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

SubscriptionOfferCodeOneTimeUseCode
object
5 properties 2 required
SubscriptionOfferDuration
string
SubscriptionOfferMode
string
ResourceLinks
object
1 property
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
csv
string
DocumentLinks
object
1 property 1 required
SubscriptionOfferCodeOneTimeUseCodeUpdateRequest
object
1 property 1 required
ErrorResponse
object
1 property
RelationshipLinks
object
2 properties
SubscriptionOfferCodeOneTimeUseCodeCreateRequest
object
1 property 1 required
ErrorSourcePointer
object
1 property 1 required
SubscriptionCustomerEligibility
string
SubscriptionOfferCodeOneTimeUseCodeResponse
object
3 properties 2 required
OfferCodeEnvironment
string
PagingInformation
object
1 property 1 required
SubscriptionOfferEligibility
string
SubscriptionOfferCode
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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