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

The InAppPurchaseOfferCodes API from iOS — 8 operation(s) for inapppurchaseoffercodes.

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

Tagged areas include InAppPurchaseOfferCodes. 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 27 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 27 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 InAppPurchaseOfferCodes 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.

InAppPurchaseOfferCodes 9
POST
/v1/inAppPurchaseOfferCodes
Create in App Purchase Offer Codes
inAppPurchaseOfferCodes_createInstance body → 400401403422201409429
GET
/v1/inAppPurchaseOfferCodes/{id}
Get in App Purchase Offer Codes
inAppPurchaseOfferCodes_getInstance 9 params → 400401403404200429
PATCH
/v1/inAppPurchaseOfferCodes/{id}
Update in App Purchase Offer Codes
inAppPurchaseOfferCodes_updateInstance 1 param body → 400401403404422200409429
GET
/v1/inAppPurchaseOfferCodes/{id}/relationships/customCodes
List Related in App Purchase Offer Codes / Custom Codes
inAppPurchaseOfferCodes_customCodes_getToManyRelationship 2 params → 400401403404200429
GET
/v1/inAppPurchaseOfferCodes/{id}/customCodes
List Related in App Purchase Offer Codes / Custom Codes
inAppPurchaseOfferCodes_customCodes_getToManyRelated 5 params → 400401403404200429
GET
/v1/inAppPurchaseOfferCodes/{id}/relationships/oneTimeUseCodes
List Related in App Purchase Offer Codes / One Time Use Codes
inAppPurchaseOfferCodes_oneTimeUseCodes_getToManyRelationship 2 params → 400401403404200429
GET
/v1/inAppPurchaseOfferCodes/{id}/oneTimeUseCodes
List Related in App Purchase Offer Codes / One Time Use Codes
inAppPurchaseOfferCodes_oneTimeUseCodes_getToManyRelated 5 params → 400401403404200429
GET
/v1/inAppPurchaseOfferCodes/{id}/relationships/prices
List Related in App Purchase Offer Codes / Prices
inAppPurchaseOfferCodes_prices_getToManyRelationship 2 params → 400401403404200429
GET
/v1/inAppPurchaseOfferCodes/{id}/prices
List Related in App Purchase Offer Codes / Prices
inAppPurchaseOfferCodes_prices_getToManyRelated 7 params → 400401403404200429

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are InAppPurchaseOfferCodeCustomCode (5 properties), InAppPurchaseOfferCodeOneTimeUseCode (5 properties), InAppPurchasePricePoint (5 properties), InAppPurchaseOfferCode (5 properties). Each schema is shown below with its type and property counts.

InAppPurchaseOfferCodeCreateRequest
object
2 properties 1 required
PagedDocumentLinks
object
3 properties 1 required
ResourceLinks
object
1 property
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
InAppPurchaseOfferPricesResponse
object
4 properties 2 required
InAppPurchaseOfferPrice
object
4 properties 2 required
DocumentLinks
object
1 property 1 required
InAppPurchaseOfferPriceInlineCreate
object
3 properties 1 required
InAppPurchaseOfferCodeOneTimeUseCodesResponse
object
4 properties 2 required
Actor
object
4 properties 2 required
ErrorResponse
object
1 property
InAppPurchaseOfferCodeOneTimeUseCodesLinkagesResponse
object
3 properties 2 required
InAppPurchaseOfferCodeCustomCode
object
5 properties 2 required
RelationshipLinks
object
2 properties
InAppPurchaseOfferCodeCustomCodesResponse
object
4 properties 2 required
ErrorSourcePointer
object
1 property 1 required
OfferCodeEnvironment
string
PagingInformation
object
1 property 1 required
InAppPurchaseOfferCodeOneTimeUseCode
object
5 properties 2 required
InAppPurchasePricePoint
object
5 properties 2 required
InAppPurchaseOfferCodePricesLinkagesResponse
object
3 properties 2 required
InAppPurchaseOfferCode
object
5 properties 2 required
InAppPurchaseOfferCodeUpdateRequest
object
1 property 1 required
InAppPurchaseOfferCodeResponse
object
3 properties 2 required
InAppPurchaseOfferCodeCustomCodesLinkagesResponse
object
3 properties 2 required
Territory
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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