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

The InAppPurchases API from iOS — 21 operation(s) for inapppurchases.

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

Tagged areas include InAppPurchases. 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 23 operations across 21 paths, and defines 59 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/.

23 operations 21 paths 59 schemas 1 DELETE20 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 InAppPurchases 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 23

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

InAppPurchases 23
GET
/v1/inAppPurchases/{id}deprecated
Get in App Purchases
inAppPurchases_getInstance 5 params → 400401403404200429
POST
/v2/inAppPurchases
Create in App Purchases V2
inAppPurchasesV2_createInstance body → 400401403422201409429
GET
/v2/inAppPurchases/{id}
Get in App Purchases V2
inAppPurchasesV2_getInstance 16 params → 400401403404200429
PATCH
/v2/inAppPurchases/{id}
Update in App Purchases V2
inAppPurchasesV2_updateInstance 1 param body → 400401403404422200409429
DELETE
/v2/inAppPurchases/{id}
Delete in App Purchases V2
inAppPurchasesV2_deleteInstance 1 param → 400401403404204429
GET
/v2/inAppPurchases/{id}/relationships/appStoreReviewScreenshot
Get Related in App Purchases V2 / App Store Review Screenshot
inAppPurchasesV2_appStoreReviewScreenshot_getToOneRelationship 1 param → 400401403404200429
GET
/v2/inAppPurchases/{id}/appStoreReviewScreenshot
Get Related in App Purchases V2 / App Store Review Screenshot
inAppPurchasesV2_appStoreReviewScreenshot_getToOneRelated 4 params → 400401403404200429
GET
/v2/inAppPurchases/{id}/relationships/content
Get Related in App Purchases V2 / Content
inAppPurchasesV2_content_getToOneRelationship 1 param → 400401403404200429
GET
/v2/inAppPurchases/{id}/content
Get Related in App Purchases V2 / Content
inAppPurchasesV2_content_getToOneRelated 4 params → 400401403404200429
GET
/v2/inAppPurchases/{id}/relationships/iapPriceSchedule
Get Related in App Purchases V2 / Iap Price Schedule
inAppPurchasesV2_iapPriceSchedule_getToOneRelationship 1 param → 400401403404200429
GET
/v2/inAppPurchases/{id}/iapPriceSchedule
Get Related in App Purchases V2 / Iap Price Schedule
inAppPurchasesV2_iapPriceSchedule_getToOneRelated 7 params → 400401403404200429
GET
/v2/inAppPurchases/{id}/relationships/images
List Related in App Purchases V2 / Images
inAppPurchasesV2_images_getToManyRelationship 2 params → 400401403404200429
GET
/v2/inAppPurchases/{id}/images
List Related in App Purchases V2 / Images
inAppPurchasesV2_images_getToManyRelated 5 params → 400401403404200429
GET
/v2/inAppPurchases/{id}/relationships/inAppPurchaseAvailability
Get Related in App Purchases V2 / in App Purchase Availability
inAppPurchasesV2_inAppPurchaseAvailability_getToOneRelationship 1 param → 400401403404200429
GET
/v2/inAppPurchases/{id}/inAppPurchaseAvailability
Get Related in App Purchases V2 / in App Purchase Availability
inAppPurchasesV2_inAppPurchaseAvailability_getToOneRelated 5 params → 400401403404200429
GET
/v2/inAppPurchases/{id}/relationships/inAppPurchaseLocalizations
List Related in App Purchases V2 / in App Purchase Localizations
inAppPurchasesV2_inAppPurchaseLocalizations_getToManyRelationship 2 params → 400401403404200429
GET
/v2/inAppPurchases/{id}/inAppPurchaseLocalizations
List Related in App Purchases V2 / in App Purchase Localizations
inAppPurchasesV2_inAppPurchaseLocalizations_getToManyRelated 5 params → 400401403404200429
GET
/v2/inAppPurchases/{id}/relationships/offerCodes
List Related in App Purchases V2 / Offer Codes
inAppPurchasesV2_offerCodes_getToManyRelationship 2 params → 400401403404200429
GET
/v2/inAppPurchases/{id}/offerCodes
List Related in App Purchases V2 / Offer Codes
inAppPurchasesV2_offerCodes_getToManyRelated 11 params → 400401403404200429
GET
/v2/inAppPurchases/{id}/relationships/pricePoints
List Related in App Purchases V2 / Price Points
inAppPurchasesV2_pricePoints_getToManyRelationship 2 params → 400401403404200429
GET
/v2/inAppPurchases/{id}/pricePoints
List Related in App Purchases V2 / Price Points
inAppPurchasesV2_pricePoints_getToManyRelated 6 params → 400401403404200429
GET
/v2/inAppPurchases/{id}/relationships/promotedPurchase
Get Related in App Purchases V2 / Promoted Purchase
inAppPurchasesV2_promotedPurchase_getToOneRelationship 1 param → 400401403404200429
GET
/v2/inAppPurchases/{id}/promotedPurchase
Get Related in App Purchases V2 / Promoted Purchase
inAppPurchasesV2_promotedPurchase_getToOneRelated 5 params → 400401403404200429

Schemas 59

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

InAppPurchasePrice
object
5 properties 2 required
ImageAsset
object
3 properties
PagedDocumentLinks
object
3 properties 1 required
InAppPurchaseAvailability
object
5 properties 2 required
PromotedPurchaseResponse
object
3 properties 2 required
ResourceLinks
object
1 property
InAppPurchaseImagesResponse
object
4 properties 2 required
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
InAppPurchaseV2InAppPurchaseLocalizationsLinkagesResponse
object
3 properties 2 required
InAppPurchaseV2UpdateRequest
object
1 property 1 required
InAppPurchaseResponse
object
3 properties 2 required
InAppPurchaseOfferPrice
object
4 properties 2 required
AppMediaAssetState
object
3 properties
csv
string
InAppPurchaseV2IapPriceScheduleLinkageResponse
object
2 properties 2 required
InAppPurchaseV2AppStoreReviewScreenshotLinkageResponse
object
2 properties 2 required
DocumentLinks
object
1 property 1 required
InAppPurchaseV2ImagesLinkagesResponse
object
3 properties 2 required
UploadOperation
object
5 properties
InAppPurchasePriceSchedule
object
4 properties 2 required
InAppPurchaseImage
object
5 properties 2 required
ErrorResponse
object
1 property
InAppPurchase
object
5 properties 2 required
InAppPurchaseContent
object
5 properties 2 required
InAppPurchaseV2OfferCodesLinkagesResponse
object
3 properties 2 required
InAppPurchaseOfferCodeCustomCode
object
5 properties 2 required
InAppPurchaseLocalizationsResponse
object
4 properties 2 required
App
object
5 properties 2 required
InAppPurchasePricePointsResponse
object
4 properties 2 required
RelationshipLinks
object
2 properties
SubscriptionStatusUrlVersion
string
PromotedPurchase
object
5 properties 2 required
InAppPurchaseAvailabilityResponse
object
3 properties 2 required
InAppPurchaseV2
object
5 properties 2 required
InAppPurchaseV2ContentLinkageResponse
object
2 properties 2 required
InAppPurchaseV2InAppPurchaseAvailabilityLinkageResponse
object
2 properties 2 required
InAppPurchaseV2Response
object
3 properties 2 required
ErrorSourcePointer
object
1 property 1 required
InAppPurchaseLocalization
object
5 properties 2 required
InAppPurchasePriceScheduleResponse
object
3 properties 2 required
OfferCodeEnvironment
string
PagingInformation
object
1 property 1 required
InAppPurchaseOfferCodeOneTimeUseCode
object
5 properties 2 required
InAppPurchaseContentResponse
object
3 properties 2 required
InAppPurchasePricePoint
object
5 properties 2 required
InAppPurchaseOfferCode
object
5 properties 2 required
InAppPurchaseV2CreateRequest
object
1 property 1 required
Subscription
object
5 properties 2 required
InAppPurchaseAppStoreReviewScreenshotResponse
object
3 properties 2 required
InAppPurchaseState
string
InAppPurchaseV2PricePointsLinkagesResponse
object
3 properties 2 required
InAppPurchaseOfferCodesResponse
object
4 properties 2 required
AppMediaStateError
object
2 properties
InAppPurchaseType
string
Territory
object
4 properties 2 required
InAppPurchaseAppStoreReviewScreenshot
object
5 properties 2 required
InAppPurchaseV2PromotedPurchaseLinkageResponse
object
2 properties 2 required
HttpHeader
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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