openapi: 3.0.1 info: title: App Store Connect AccessibilityDeclarations InAppPurchases API version: 4.3.1 x-platforms: app_store_connect_api: App Store Connect API description: The App Store Connect API is the standards-based REST API Apple provides to automate tasks across App Store Connect, Xcode, and Certificates, Identifiers & Profiles. It covers apps, builds, TestFlight, in-app purchases, subscriptions, Game Center, Xcode Cloud, provisioning, pricing and availability, and the full reporting surface (analytics, sales and trends, financial reports, power and performance). This spec is the official OpenAPI 3.0 document published by Apple at https://developer.apple.com/app-store-connect/api/ — mirrored here unmodified except for title-cased operation summaries. servers: - url: https://api.appstoreconnect.apple.com/ security: - itc-bearer-token: [] tags: - name: InAppPurchases paths: /v1/inAppPurchases/{id}: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - InAppPurchases operationId: inAppPurchases_getInstance deprecated: true parameters: - name: fields[inAppPurchases] in: query description: the fields to include for returned resources of type inAppPurchases schema: type: array items: type: string enum: - referenceName - productId - inAppPurchaseType - state - apps style: form explode: false required: false - name: fields[apps] in: query description: the fields to include for returned resources of type apps schema: type: array items: type: string enum: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails style: form explode: false required: false - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - apps style: form explode: false required: false - name: limit[apps] in: query description: maximum number of related apps returned (when they are included) schema: type: integer maximum: 50 style: form required: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single InAppPurchase content: application/json: schema: $ref: '#/components/schemas/InAppPurchaseResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get in App Purchases /v2/inAppPurchases: post: tags: - InAppPurchases operationId: inAppPurchasesV2_createInstance requestBody: description: InAppPurchase representation content: application/json: schema: $ref: '#/components/schemas/InAppPurchaseV2CreateRequest' required: true responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Unprocessable request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '201': description: Single InAppPurchase content: application/json: schema: $ref: '#/components/schemas/InAppPurchaseV2Response' '409': description: Request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Create in App Purchases V2 /v2/inAppPurchases/{id}: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - InAppPurchases operationId: inAppPurchasesV2_getInstance parameters: - name: fields[inAppPurchases] in: query description: the fields to include for returned resources of type inAppPurchases schema: type: array items: type: string enum: - name - productId - inAppPurchaseType - state - reviewNote - familySharable - contentHosting - inAppPurchaseLocalizations - pricePoints - content - appStoreReviewScreenshot - promotedPurchase - iapPriceSchedule - inAppPurchaseAvailability - images - offerCodes style: form explode: false required: false - name: fields[inAppPurchaseLocalizations] in: query description: the fields to include for returned resources of type inAppPurchaseLocalizations schema: type: array items: type: string enum: - name - locale - description - state - inAppPurchaseV2 style: form explode: false required: false - name: fields[inAppPurchasePricePoints] in: query description: the fields to include for returned resources of type inAppPurchasePricePoints schema: type: array items: type: string enum: - customerPrice - proceeds - territory - equalizations style: form explode: false required: false - name: fields[inAppPurchaseContents] in: query description: the fields to include for returned resources of type inAppPurchaseContents schema: type: array items: type: string enum: - fileName - fileSize - url - lastModifiedDate - inAppPurchaseV2 style: form explode: false required: false - name: fields[inAppPurchaseAppStoreReviewScreenshots] in: query description: the fields to include for returned resources of type inAppPurchaseAppStoreReviewScreenshots schema: type: array items: type: string enum: - fileSize - fileName - sourceFileChecksum - imageAsset - assetToken - assetType - uploadOperations - assetDeliveryState - inAppPurchaseV2 style: form explode: false required: false - name: fields[promotedPurchases] in: query description: the fields to include for returned resources of type promotedPurchases schema: type: array items: type: string enum: - visibleForAllUsers - enabled - state - inAppPurchaseV2 - subscription style: form explode: false required: false - name: fields[inAppPurchasePriceSchedules] in: query description: the fields to include for returned resources of type inAppPurchasePriceSchedules schema: type: array items: type: string enum: - baseTerritory - manualPrices - automaticPrices style: form explode: false required: false - name: fields[inAppPurchaseAvailabilities] in: query description: the fields to include for returned resources of type inAppPurchaseAvailabilities schema: type: array items: type: string enum: - availableInNewTerritories - availableTerritories style: form explode: false required: false - name: fields[inAppPurchaseImages] in: query description: the fields to include for returned resources of type inAppPurchaseImages schema: type: array items: type: string enum: - fileSize - fileName - sourceFileChecksum - assetToken - imageAsset - uploadOperations - state - inAppPurchase style: form explode: false required: false - name: fields[inAppPurchaseOfferCodes] in: query description: the fields to include for returned resources of type inAppPurchaseOfferCodes schema: type: array items: type: string enum: - name - customerEligibilities - productionCodeCount - sandboxCodeCount - active - oneTimeUseCodes - customCodes - prices style: form explode: false required: false - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - inAppPurchaseLocalizations - pricePoints - content - appStoreReviewScreenshot - promotedPurchase - iapPriceSchedule - inAppPurchaseAvailability - images - offerCodes style: form explode: false required: false - name: limit[images] in: query description: maximum number of related images returned (when they are included) schema: type: integer maximum: 50 style: form required: false - name: limit[inAppPurchaseLocalizations] in: query description: maximum number of related inAppPurchaseLocalizations returned (when they are included) schema: type: integer maximum: 50 style: form required: false - name: limit[offerCodes] in: query description: maximum number of related offerCodes returned (when they are included) schema: type: integer maximum: 50 style: form required: false - name: limit[pricePoints] in: query description: maximum number of related pricePoints returned (when they are included) schema: type: integer maximum: 8000 style: form required: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single InAppPurchase content: application/json: schema: $ref: '#/components/schemas/InAppPurchaseV2Response' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get in App Purchases V2 patch: tags: - InAppPurchases operationId: inAppPurchasesV2_updateInstance requestBody: description: InAppPurchase representation content: application/json: schema: $ref: '#/components/schemas/InAppPurchaseV2UpdateRequest' required: true responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Unprocessable request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single InAppPurchase content: application/json: schema: $ref: '#/components/schemas/InAppPurchaseV2Response' '409': description: Request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Update in App Purchases V2 delete: tags: - InAppPurchases operationId: inAppPurchasesV2_deleteInstance responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '204': description: Success (no content) '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Delete in App Purchases V2 /v2/inAppPurchases/{id}/relationships/appStoreReviewScreenshot: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - InAppPurchases operationId: inAppPurchasesV2_appStoreReviewScreenshot_getToOneRelationship parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/InAppPurchaseV2AppStoreReviewScreenshotLinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related in App Purchases V2 / App Store Review Screenshot /v2/inAppPurchases/{id}/appStoreReviewScreenshot: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - InAppPurchases operationId: inAppPurchasesV2_appStoreReviewScreenshot_getToOneRelated parameters: - name: fields[inAppPurchaseAppStoreReviewScreenshots] in: query description: the fields to include for returned resources of type inAppPurchaseAppStoreReviewScreenshots schema: type: array items: type: string enum: - fileSize - fileName - sourceFileChecksum - imageAsset - assetToken - assetType - uploadOperations - assetDeliveryState - inAppPurchaseV2 style: form explode: false - name: fields[inAppPurchases] in: query description: the fields to include for returned resources of type inAppPurchases schema: type: array items: type: string enum: - name - productId - inAppPurchaseType - state - reviewNote - familySharable - contentHosting - inAppPurchaseLocalizations - pricePoints - content - appStoreReviewScreenshot - promotedPurchase - iapPriceSchedule - inAppPurchaseAvailability - images - offerCodes style: form explode: false - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - inAppPurchaseV2 style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single InAppPurchaseAppStoreReviewScreenshot content: application/json: schema: $ref: '#/components/schemas/InAppPurchaseAppStoreReviewScreenshotResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related in App Purchases V2 / App Store Review Screenshot /v2/inAppPurchases/{id}/relationships/content: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - InAppPurchases operationId: inAppPurchasesV2_content_getToOneRelationship parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/InAppPurchaseV2ContentLinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related in App Purchases V2 / Content /v2/inAppPurchases/{id}/content: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - InAppPurchases operationId: inAppPurchasesV2_content_getToOneRelated parameters: - name: fields[inAppPurchaseContents] in: query description: the fields to include for returned resources of type inAppPurchaseContents schema: type: array items: type: string enum: - fileName - fileSize - url - lastModifiedDate - inAppPurchaseV2 style: form explode: false - name: fields[inAppPurchases] in: query description: the fields to include for returned resources of type inAppPurchases schema: type: array items: type: string enum: - name - productId - inAppPurchaseType - state - reviewNote - familySharable - contentHosting - inAppPurchaseLocalizations - pricePoints - content - appStoreReviewScreenshot - promotedPurchase - iapPriceSchedule - inAppPurchaseAvailability - images - offerCodes style: form explode: false - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - inAppPurchaseV2 style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single InAppPurchaseContent content: application/json: schema: $ref: '#/components/schemas/InAppPurchaseContentResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related in App Purchases V2 / Content /v2/inAppPurchases/{id}/relationships/iapPriceSchedule: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - InAppPurchases operationId: inAppPurchasesV2_iapPriceSchedule_getToOneRelationship parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/InAppPurchaseV2IapPriceScheduleLinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related in App Purchases V2 / Iap Price Schedule /v2/inAppPurchases/{id}/iapPriceSchedule: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - InAppPurchases operationId: inAppPurchasesV2_iapPriceSchedule_getToOneRelated parameters: - name: fields[inAppPurchasePriceSchedules] in: query description: the fields to include for returned resources of type inAppPurchasePriceSchedules schema: type: array items: type: string enum: - baseTerritory - manualPrices - automaticPrices style: form explode: false - name: fields[territories] in: query description: the fields to include for returned resources of type territories schema: type: array items: type: string enum: - currency style: form explode: false - name: fields[inAppPurchasePrices] in: query description: the fields to include for returned resources of type inAppPurchasePrices schema: type: array items: type: string enum: - startDate - endDate - manual - inAppPurchasePricePoint - territory style: form explode: false - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - baseTerritory - manualPrices - automaticPrices style: form explode: false - name: limit[manualPrices] in: query description: maximum number of related manualPrices returned (when they are included) schema: type: integer maximum: 50 style: form - name: limit[automaticPrices] in: query description: maximum number of related automaticPrices returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single InAppPurchasePriceSchedule content: application/json: schema: $ref: '#/components/schemas/InAppPurchasePriceScheduleResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related in App Purchases V2 / Iap Price Schedule /v2/inAppPurchases/{id}/relationships/images: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - InAppPurchases operationId: inAppPurchasesV2_images_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/InAppPurchaseV2ImagesLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related in App Purchases V2 / Images /v2/inAppPurchases/{id}/images: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - InAppPurchases operationId: inAppPurchasesV2_images_getToManyRelated parameters: - name: fields[inAppPurchaseImages] in: query description: the fields to include for returned resources of type inAppPurchaseImages schema: type: array items: type: string enum: - fileSize - fileName - sourceFileChecksum - assetToken - imageAsset - uploadOperations - state - inAppPurchase style: form explode: false - name: fields[inAppPurchases] in: query description: the fields to include for returned resources of type inAppPurchases schema: type: array items: type: string enum: - name - productId - inAppPurchaseType - state - reviewNote - familySharable - contentHosting - inAppPurchaseLocalizations - pricePoints - content - appStoreReviewScreenshot - promotedPurchase - iapPriceSchedule - inAppPurchaseAvailability - images - offerCodes style: form explode: false - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - inAppPurchase style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of InAppPurchaseImages content: application/json: schema: $ref: '#/components/schemas/InAppPurchaseImagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related in App Purchases V2 / Images /v2/inAppPurchases/{id}/relationships/inAppPurchaseAvailability: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - InAppPurchases operationId: inAppPurchasesV2_inAppPurchaseAvailability_getToOneRelationship parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/InAppPurchaseV2InAppPurchaseAvailabilityLinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related in App Purchases V2 / in App Purchase Availability /v2/inAppPurchases/{id}/inAppPurchaseAvailability: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - InAppPurchases operationId: inAppPurchasesV2_inAppPurchaseAvailability_getToOneRelated parameters: - name: fields[inAppPurchaseAvailabilities] in: query description: the fields to include for returned resources of type inAppPurchaseAvailabilities schema: type: array items: type: string enum: - availableInNewTerritories - availableTerritories style: form explode: false - name: fields[territories] in: query description: the fields to include for returned resources of type territories schema: type: array items: type: string enum: - currency style: form explode: false - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - availableTerritories style: form explode: false - name: limit[availableTerritories] in: query description: maximum number of related availableTerritories returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single InAppPurchaseAvailability content: application/json: schema: $ref: '#/components/schemas/InAppPurchaseAvailabilityResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related in App Purchases V2 / in App Purchase Availability /v2/inAppPurchases/{id}/relationships/inAppPurchaseLocalizations: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - InAppPurchases operationId: inAppPurchasesV2_inAppPurchaseLocalizations_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/InAppPurchaseV2InAppPurchaseLocalizationsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related in App Purchases V2 / in App Purchase Localizations /v2/inAppPurchases/{id}/inAppPurchaseLocalizations: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - InAppPurchases operationId: inAppPurchasesV2_inAppPurchaseLocalizations_getToManyRelated parameters: - name: fields[inAppPurchaseLocalizations] in: query description: the fields to include for returned resources of type inAppPurchaseLocalizations schema: type: array items: type: string enum: - name - locale - description - state - inAppPurchaseV2 style: form explode: false - name: fields[inAppPurchases] in: query description: the fields to include for returned resources of type inAppPurchases schema: type: array items: type: string enum: - name - productId - inAppPurchaseType - state - reviewNote - familySharable - contentHosting - inAppPurchaseLocalizations - pricePoints - content - appStoreReviewScreenshot - promotedPurchase - iapPriceSchedule - inAppPurchaseAvailability - images - offerCodes style: form explode: false - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - inAppPurchaseV2 style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of InAppPurchaseLocalizations content: application/json: schema: $ref: '#/components/schemas/InAppPurchaseLocalizationsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related in App Purchases V2 / in App Purchase Localizations /v2/inAppPurchases/{id}/relationships/offerCodes: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - InAppPurchases operationId: inAppPurchasesV2_offerCodes_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/InAppPurchaseV2OfferCodesLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related in App Purchases V2 / Offer Codes /v2/inAppPurchases/{id}/offerCodes: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - InAppPurchases operationId: inAppPurchasesV2_offerCodes_getToManyRelated parameters: - name: filter[territory] in: query description: filter by territory schema: type: array items: type: string style: form explode: false - name: fields[inAppPurchaseOfferCodes] in: query description: the fields to include for returned resources of type inAppPurchaseOfferCodes schema: type: array items: type: string enum: - name - customerEligibilities - productionCodeCount - sandboxCodeCount - active - oneTimeUseCodes - customCodes - prices style: form explode: false - name: fields[inAppPurchaseOfferCodeOneTimeUseCodes] in: query description: the fields to include for returned resources of type inAppPurchaseOfferCodeOneTimeUseCodes schema: type: array items: type: string enum: - numberOfCodes - createdDate - expirationDate - active - environment - values - createdByActor - deactivatedByActor style: form explode: false - name: fields[inAppPurchaseOfferCodeCustomCodes] in: query description: the fields to include for returned resources of type inAppPurchaseOfferCodeCustomCodes schema: type: array items: type: string enum: - customCode - numberOfCodes - createdDate - expirationDate - active - createdByActor - deactivatedByActor style: form explode: false - name: fields[inAppPurchaseOfferPrices] in: query description: the fields to include for returned resources of type inAppPurchaseOfferPrices schema: type: array items: type: string enum: - territory - pricePoint style: form explode: false - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - oneTimeUseCodes - customCodes - prices style: form explode: false - name: limit[oneTimeUseCodes] in: query description: maximum number of related oneTimeUseCodes returned (when they are included) schema: type: integer maximum: 50 style: form - name: limit[customCodes] in: query description: maximum number of related customCodes returned (when they are included) schema: type: integer maximum: 50 style: form - name: limit[prices] in: query description: maximum number of related prices returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of InAppPurchaseOfferCodes content: application/json: schema: $ref: '#/components/schemas/InAppPurchaseOfferCodesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related in App Purchases V2 / Offer Codes /v2/inAppPurchases/{id}/relationships/pricePoints: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - InAppPurchases operationId: inAppPurchasesV2_pricePoints_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 8000 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/InAppPurchaseV2PricePointsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related in App Purchases V2 / Price Points /v2/inAppPurchases/{id}/pricePoints: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - InAppPurchases operationId: inAppPurchasesV2_pricePoints_getToManyRelated parameters: - name: filter[territory] in: query description: filter by id(s) of related 'territory' schema: type: array items: type: string style: form explode: false - name: fields[inAppPurchasePricePoints] in: query description: the fields to include for returned resources of type inAppPurchasePricePoints schema: type: array items: type: string enum: - customerPrice - proceeds - territory - equalizations style: form explode: false - name: fields[territories] in: query description: the fields to include for returned resources of type territories schema: type: array items: type: string enum: - currency style: form explode: false - name: limit in: query description: maximum resources per page schema: type: integer maximum: 8000 style: form - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - territory style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of InAppPurchasePricePoints content: application/json: schema: $ref: '#/components/schemas/InAppPurchasePricePointsResponse' text/csv: schema: $ref: '#/components/schemas/csv' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related in App Purchases V2 / Price Points /v2/inAppPurchases/{id}/relationships/promotedPurchase: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - InAppPurchases operationId: inAppPurchasesV2_promotedPurchase_getToOneRelationship parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/InAppPurchaseV2PromotedPurchaseLinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related in App Purchases V2 / Promoted Purchase /v2/inAppPurchases/{id}/promotedPurchase: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - InAppPurchases operationId: inAppPurchasesV2_promotedPurchase_getToOneRelated parameters: - name: fields[promotedPurchases] in: query description: the fields to include for returned resources of type promotedPurchases schema: type: array items: type: string enum: - visibleForAllUsers - enabled - state - inAppPurchaseV2 - subscription style: form explode: false - name: fields[inAppPurchases] in: query description: the fields to include for returned resources of type inAppPurchases schema: type: array items: type: string enum: - name - productId - inAppPurchaseType - state - reviewNote - familySharable - contentHosting - inAppPurchaseLocalizations - pricePoints - content - appStoreReviewScreenshot - promotedPurchase - iapPriceSchedule - inAppPurchaseAvailability - images - offerCodes style: form explode: false - name: fields[subscriptions] in: query description: the fields to include for returned resources of type subscriptions schema: type: array items: type: string enum: - name - productId - familySharable - state - subscriptionPeriod - reviewNote - groupLevel - subscriptionLocalizations - appStoreReviewScreenshot - group - introductoryOffers - promotionalOffers - offerCodes - prices - pricePoints - promotedPurchase - subscriptionAvailability - winBackOffers - images style: form explode: false - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - inAppPurchaseV2 - subscription style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single PromotedPurchase content: application/json: schema: $ref: '#/components/schemas/PromotedPurchaseResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related in App Purchases V2 / Promoted Purchase components: schemas: InAppPurchasePrice: type: object title: InAppPurchasePrice properties: type: type: string enum: - inAppPurchasePrices id: type: string attributes: type: object properties: startDate: type: string format: date endDate: type: string format: date manual: type: boolean relationships: type: object properties: inAppPurchasePricePoint: type: object properties: data: type: object properties: type: type: string enum: - inAppPurchasePricePoints id: type: string required: - id - type territory: type: object properties: data: type: object properties: type: type: string enum: - territories id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type ImageAsset: type: object properties: templateUrl: type: string width: type: integer height: type: integer PagedDocumentLinks: type: object properties: self: type: string format: uri-reference first: type: string format: uri-reference next: type: string format: uri-reference required: - self InAppPurchaseAvailability: type: object title: InAppPurchaseAvailability properties: type: type: string enum: - inAppPurchaseAvailabilities id: type: string attributes: type: object properties: availableInNewTerritories: type: boolean relationships: type: object properties: availableTerritories: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - territories id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type PromotedPurchaseResponse: type: object title: PromotedPurchaseResponse properties: data: $ref: '#/components/schemas/PromotedPurchase' included: type: array items: oneOf: - $ref: '#/components/schemas/InAppPurchaseV2' - $ref: '#/components/schemas/Subscription' discriminator: propertyName: type mapping: subscriptions: '#/components/schemas/Subscription' inAppPurchases: '#/components/schemas/InAppPurchaseV2' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links ResourceLinks: type: object properties: self: type: string format: uri-reference InAppPurchaseImagesResponse: type: object title: InAppPurchaseImagesResponse properties: data: type: array items: $ref: '#/components/schemas/InAppPurchaseImage' included: type: array items: $ref: '#/components/schemas/InAppPurchaseV2' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links ErrorSourceParameter: type: object title: Parameter properties: parameter: type: string required: - parameter ErrorLinks: type: object properties: about: type: string format: uri-reference associated: oneOf: - type: string format: uri-reference - type: object properties: href: type: string format: uri-reference meta: type: object properties: source: type: string InAppPurchaseV2InAppPurchaseLocalizationsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - inAppPurchaseLocalizations id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links InAppPurchaseV2UpdateRequest: type: object title: InAppPurchaseV2UpdateRequest properties: data: type: object properties: type: type: string enum: - inAppPurchases id: type: string attributes: type: object properties: name: type: string nullable: true reviewNote: type: string nullable: true familySharable: type: boolean nullable: true required: - id - type required: - data InAppPurchaseResponse: type: object title: InAppPurchaseResponse properties: data: $ref: '#/components/schemas/InAppPurchase' included: type: array items: $ref: '#/components/schemas/App' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links deprecated: true InAppPurchaseOfferPrice: type: object title: InAppPurchaseOfferPrice properties: type: type: string enum: - inAppPurchaseOfferPrices id: type: string relationships: type: object properties: territory: type: object properties: data: type: object properties: type: type: string enum: - territories id: type: string required: - id - type pricePoint: type: object properties: data: type: object properties: type: type: string enum: - inAppPurchasePricePoints id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppMediaAssetState: type: object properties: errors: type: array items: $ref: '#/components/schemas/AppMediaStateError' warnings: type: array items: $ref: '#/components/schemas/AppMediaStateError' state: type: string enum: - AWAITING_UPLOAD - UPLOAD_COMPLETE - COMPLETE - FAILED csv: type: string InAppPurchaseV2IapPriceScheduleLinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - inAppPurchasePriceSchedules id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links InAppPurchaseV2AppStoreReviewScreenshotLinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - inAppPurchaseAppStoreReviewScreenshots id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links DocumentLinks: type: object properties: self: type: string format: uri-reference required: - self InAppPurchaseV2ImagesLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - inAppPurchaseImages id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links UploadOperation: type: object properties: method: type: string url: type: string length: type: integer offset: type: integer requestHeaders: type: array items: $ref: '#/components/schemas/HttpHeader' InAppPurchasePriceSchedule: type: object title: InAppPurchasePriceSchedule properties: type: type: string enum: - inAppPurchasePriceSchedules id: type: string relationships: type: object properties: baseTerritory: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - territories id: type: string required: - id - type manualPrices: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchasePrices id: type: string required: - id - type automaticPrices: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchasePrices id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type InAppPurchaseImage: type: object title: InAppPurchaseImage properties: type: type: string enum: - inAppPurchaseImages id: type: string attributes: type: object properties: fileSize: type: integer fileName: type: string sourceFileChecksum: type: string assetToken: type: string imageAsset: $ref: '#/components/schemas/ImageAsset' uploadOperations: type: array items: $ref: '#/components/schemas/UploadOperation' state: type: string enum: - AWAITING_UPLOAD - UPLOAD_COMPLETE - FAILED - PREPARE_FOR_SUBMISSION - WAITING_FOR_REVIEW - APPROVED - REJECTED relationships: type: object properties: inAppPurchase: type: object properties: data: type: object properties: type: type: string enum: - inAppPurchases id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type ErrorResponse: type: object properties: errors: type: array items: type: object properties: id: type: string status: type: string code: type: string title: type: string detail: type: string source: oneOf: - $ref: '#/components/schemas/ErrorSourcePointer' - $ref: '#/components/schemas/ErrorSourceParameter' links: $ref: '#/components/schemas/ErrorLinks' meta: type: object additionalProperties: {} required: - code - detail - status - title InAppPurchase: type: object title: InAppPurchase properties: type: type: string enum: - inAppPurchases id: type: string attributes: type: object properties: referenceName: type: string productId: type: string inAppPurchaseType: type: string enum: - AUTOMATICALLY_RENEWABLE_SUBSCRIPTION - NON_CONSUMABLE - CONSUMABLE - NON_RENEWING_SUBSCRIPTION - FREE_SUBSCRIPTION state: type: string enum: - CREATED - DEVELOPER_SIGNED_OFF - DEVELOPER_ACTION_NEEDED - DELETION_IN_PROGRESS - APPROVED - DELETED - REMOVED_FROM_SALE - DEVELOPER_REMOVED_FROM_SALE - WAITING_FOR_UPLOAD - PROCESSING_CONTENT - REPLACED - REJECTED - WAITING_FOR_SCREENSHOT - PREPARE_FOR_SUBMISSION - MISSING_METADATA - READY_TO_SUBMIT - WAITING_FOR_REVIEW - IN_REVIEW - PENDING_DEVELOPER_RELEASE relationships: type: object properties: apps: type: object properties: meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - apps id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type deprecated: true InAppPurchaseContent: type: object title: InAppPurchaseContent properties: type: type: string enum: - inAppPurchaseContents id: type: string attributes: type: object properties: fileName: type: string fileSize: type: integer url: type: string format: uri lastModifiedDate: type: string format: date-time relationships: type: object properties: inAppPurchaseV2: type: object properties: data: type: object properties: type: type: string enum: - inAppPurchases id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type InAppPurchaseV2OfferCodesLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - inAppPurchaseOfferCodes id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links InAppPurchaseOfferCodeCustomCode: type: object title: InAppPurchaseOfferCodeCustomCode properties: type: type: string enum: - inAppPurchaseOfferCodeCustomCodes id: type: string attributes: type: object properties: customCode: type: string numberOfCodes: type: integer createdDate: type: string format: date-time expirationDate: type: string format: date active: type: boolean relationships: type: object properties: createdByActor: type: object properties: data: type: object properties: type: type: string enum: - actors id: type: string required: - id - type deactivatedByActor: type: object properties: data: type: object properties: type: type: string enum: - actors id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type InAppPurchaseLocalizationsResponse: type: object title: InAppPurchaseLocalizationsResponse properties: data: type: array items: $ref: '#/components/schemas/InAppPurchaseLocalization' included: type: array items: $ref: '#/components/schemas/InAppPurchaseV2' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links App: type: object title: App properties: type: type: string enum: - apps id: type: string attributes: type: object properties: accessibilityUrl: type: string format: uri name: type: string bundleId: type: string sku: type: string primaryLocale: type: string isOrEverWasMadeForKids: type: boolean subscriptionStatusUrl: type: string format: uri subscriptionStatusUrlVersion: $ref: '#/components/schemas/SubscriptionStatusUrlVersion' subscriptionStatusUrlForSandbox: type: string format: uri subscriptionStatusUrlVersionForSandbox: $ref: '#/components/schemas/SubscriptionStatusUrlVersion' contentRightsDeclaration: type: string enum: - DOES_NOT_USE_THIRD_PARTY_CONTENT - USES_THIRD_PARTY_CONTENT streamlinedPurchasingEnabled: type: boolean relationships: type: object properties: accessibilityDeclarations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' appEncryptionDeclarations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appEncryptionDeclarations id: type: string required: - id - type appStoreIcon: type: object properties: data: type: object properties: type: type: string enum: - buildIcons id: type: string required: - id - type ciProduct: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - ciProducts id: type: string required: - id - type betaTesters: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' betaGroups: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - betaGroups id: type: string required: - id - type appStoreVersions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type appTags: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' preReleaseVersions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - preReleaseVersions id: type: string required: - id - type betaAppLocalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - betaAppLocalizations id: type: string required: - id - type builds: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - builds id: type: string required: - id - type betaLicenseAgreement: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - betaLicenseAgreements id: type: string required: - id - type betaAppReviewDetail: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - betaAppReviewDetails id: type: string required: - id - type appInfos: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appInfos id: type: string required: - id - type appClips: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appClips id: type: string required: - id - type appPricePoints: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' endUserLicenseAgreement: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - endUserLicenseAgreements id: type: string required: - id - type appPriceSchedule: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' appAvailabilityV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' inAppPurchases: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchases id: type: string required: - id - type deprecated: true subscriptionGroups: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - subscriptionGroups id: type: string required: - id - type gameCenterEnabledVersions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterEnabledVersions id: type: string required: - id - type perfPowerMetrics: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' appCustomProductPages: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appCustomProductPages id: type: string required: - id - type inAppPurchasesV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchases id: type: string required: - id - type promotedPurchases: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - promotedPurchases id: type: string required: - id - type appEvents: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appEvents id: type: string required: - id - type reviewSubmissions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - reviewSubmissions id: type: string required: - id - type subscriptionGracePeriod: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - subscriptionGracePeriods id: type: string required: - id - type customerReviews: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' customerReviewSummarizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' gameCenterDetail: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - gameCenterDetails id: type: string required: - id - type appStoreVersionExperimentsV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersionExperiments id: type: string required: - id - type alternativeDistributionKey: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' analyticsReportRequests: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' marketplaceSearchDetail: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' buildUploads: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' backgroundAssets: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' betaFeedbackScreenshotSubmissions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' betaFeedbackCrashSubmissions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' searchKeywords: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' webhooks: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' androidToIosAppMappingDetails: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - androidToIosAppMappingDetails id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type InAppPurchasePricePointsResponse: type: object title: InAppPurchasePricePointsResponse properties: data: type: array items: $ref: '#/components/schemas/InAppPurchasePricePoint' included: type: array items: $ref: '#/components/schemas/Territory' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links RelationshipLinks: type: object properties: self: type: string format: uri-reference related: type: string format: uri-reference SubscriptionStatusUrlVersion: type: string enum: - V1 - V2 PromotedPurchase: type: object title: PromotedPurchase properties: type: type: string enum: - promotedPurchases id: type: string attributes: type: object properties: visibleForAllUsers: type: boolean enabled: type: boolean state: type: string enum: - APPROVED - IN_REVIEW - PREPARE_FOR_SUBMISSION - REJECTED relationships: type: object properties: inAppPurchaseV2: type: object properties: data: type: object properties: type: type: string enum: - inAppPurchases id: type: string required: - id - type subscription: type: object properties: data: type: object properties: type: type: string enum: - subscriptions id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type InAppPurchaseAvailabilityResponse: type: object title: InAppPurchaseAvailabilityResponse properties: data: $ref: '#/components/schemas/InAppPurchaseAvailability' included: type: array items: $ref: '#/components/schemas/Territory' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links InAppPurchaseV2: type: object title: InAppPurchaseV2 properties: type: type: string enum: - inAppPurchases id: type: string attributes: type: object properties: name: type: string productId: type: string inAppPurchaseType: $ref: '#/components/schemas/InAppPurchaseType' state: $ref: '#/components/schemas/InAppPurchaseState' reviewNote: type: string familySharable: type: boolean contentHosting: type: boolean relationships: type: object properties: inAppPurchaseLocalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchaseLocalizations id: type: string required: - id - type pricePoints: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchasePricePoints id: type: string required: - id - type content: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - inAppPurchaseContents id: type: string required: - id - type appStoreReviewScreenshot: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - inAppPurchaseAppStoreReviewScreenshots id: type: string required: - id - type promotedPurchase: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - promotedPurchases id: type: string required: - id - type iapPriceSchedule: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - inAppPurchasePriceSchedules id: type: string required: - id - type inAppPurchaseAvailability: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - inAppPurchaseAvailabilities id: type: string required: - id - type images: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchaseImages id: type: string required: - id - type offerCodes: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchaseOfferCodes id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type InAppPurchaseV2ContentLinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - inAppPurchaseContents id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links InAppPurchaseV2InAppPurchaseAvailabilityLinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - inAppPurchaseAvailabilities id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links InAppPurchaseV2Response: type: object title: InAppPurchaseV2Response properties: data: $ref: '#/components/schemas/InAppPurchaseV2' included: type: array items: oneOf: - $ref: '#/components/schemas/InAppPurchaseAppStoreReviewScreenshot' - $ref: '#/components/schemas/InAppPurchaseAvailability' - $ref: '#/components/schemas/InAppPurchaseContent' - $ref: '#/components/schemas/InAppPurchaseImage' - $ref: '#/components/schemas/InAppPurchaseLocalization' - $ref: '#/components/schemas/InAppPurchaseOfferCode' - $ref: '#/components/schemas/InAppPurchasePricePoint' - $ref: '#/components/schemas/InAppPurchasePriceSchedule' - $ref: '#/components/schemas/PromotedPurchase' discriminator: propertyName: type mapping: inAppPurchaseAppStoreReviewScreenshots: '#/components/schemas/InAppPurchaseAppStoreReviewScreenshot' inAppPurchaseContents: '#/components/schemas/InAppPurchaseContent' inAppPurchaseOfferCodes: '#/components/schemas/InAppPurchaseOfferCode' inAppPurchasePriceSchedules: '#/components/schemas/InAppPurchasePriceSchedule' promotedPurchases: '#/components/schemas/PromotedPurchase' inAppPurchaseImages: '#/components/schemas/InAppPurchaseImage' inAppPurchaseAvailabilities: '#/components/schemas/InAppPurchaseAvailability' inAppPurchasePricePoints: '#/components/schemas/InAppPurchasePricePoint' inAppPurchaseLocalizations: '#/components/schemas/InAppPurchaseLocalization' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links ErrorSourcePointer: type: object title: JsonPointer properties: pointer: type: string required: - pointer InAppPurchaseLocalization: type: object title: InAppPurchaseLocalization properties: type: type: string enum: - inAppPurchaseLocalizations id: type: string attributes: type: object properties: name: type: string locale: type: string description: type: string state: type: string enum: - PREPARE_FOR_SUBMISSION - WAITING_FOR_REVIEW - APPROVED - REJECTED relationships: type: object properties: inAppPurchaseV2: type: object properties: data: type: object properties: type: type: string enum: - inAppPurchases id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type InAppPurchasePriceScheduleResponse: type: object title: InAppPurchasePriceScheduleResponse properties: data: $ref: '#/components/schemas/InAppPurchasePriceSchedule' included: type: array items: oneOf: - $ref: '#/components/schemas/InAppPurchasePrice' - $ref: '#/components/schemas/Territory' discriminator: propertyName: type mapping: territories: '#/components/schemas/Territory' inAppPurchasePrices: '#/components/schemas/InAppPurchasePrice' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links OfferCodeEnvironment: type: string enum: - PRODUCTION - SANDBOX PagingInformation: type: object properties: paging: type: object properties: total: type: integer limit: type: integer nextCursor: type: string required: - limit required: - paging InAppPurchaseOfferCodeOneTimeUseCode: type: object title: InAppPurchaseOfferCodeOneTimeUseCode properties: type: type: string enum: - inAppPurchaseOfferCodeOneTimeUseCodes id: type: string attributes: type: object properties: numberOfCodes: type: integer createdDate: type: string format: date-time expirationDate: type: string format: date active: type: boolean environment: $ref: '#/components/schemas/OfferCodeEnvironment' relationships: type: object properties: values: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' createdByActor: type: object properties: data: type: object properties: type: type: string enum: - actors id: type: string required: - id - type deactivatedByActor: type: object properties: data: type: object properties: type: type: string enum: - actors id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type InAppPurchaseContentResponse: type: object title: InAppPurchaseContentResponse properties: data: $ref: '#/components/schemas/InAppPurchaseContent' included: type: array items: $ref: '#/components/schemas/InAppPurchaseV2' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links InAppPurchasePricePoint: type: object title: InAppPurchasePricePoint properties: type: type: string enum: - inAppPurchasePricePoints id: type: string attributes: type: object properties: customerPrice: type: string proceeds: type: string relationships: type: object properties: territory: type: object properties: data: type: object properties: type: type: string enum: - territories id: type: string required: - id - type equalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' links: $ref: '#/components/schemas/ResourceLinks' required: - id - type InAppPurchaseOfferCode: type: object title: InAppPurchaseOfferCode properties: type: type: string enum: - inAppPurchaseOfferCodes id: type: string attributes: type: object properties: name: type: string customerEligibilities: type: array items: type: string enum: - NON_SPENDER - ACTIVE_SPENDER - CHURNED_SPENDER productionCodeCount: type: integer sandboxCodeCount: type: integer active: type: boolean relationships: type: object properties: oneTimeUseCodes: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchaseOfferCodeOneTimeUseCodes id: type: string required: - id - type customCodes: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchaseOfferCodeCustomCodes id: type: string required: - id - type prices: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchaseOfferPrices id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type InAppPurchaseV2CreateRequest: type: object title: InAppPurchaseV2CreateRequest properties: data: type: object properties: type: type: string enum: - inAppPurchases attributes: type: object properties: name: type: string productId: type: string inAppPurchaseType: $ref: '#/components/schemas/InAppPurchaseType' reviewNote: type: string nullable: true familySharable: type: boolean nullable: true required: - productId - name - inAppPurchaseType relationships: type: object properties: app: type: object properties: data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type required: - data required: - app required: - relationships - attributes - type required: - data Subscription: type: object title: Subscription properties: type: type: string enum: - subscriptions id: type: string attributes: type: object properties: name: type: string productId: type: string familySharable: type: boolean state: type: string enum: - MISSING_METADATA - READY_TO_SUBMIT - WAITING_FOR_REVIEW - IN_REVIEW - DEVELOPER_ACTION_NEEDED - PENDING_BINARY_APPROVAL - APPROVED - DEVELOPER_REMOVED_FROM_SALE - REMOVED_FROM_SALE - REJECTED subscriptionPeriod: type: string enum: - ONE_WEEK - ONE_MONTH - TWO_MONTHS - THREE_MONTHS - SIX_MONTHS - ONE_YEAR reviewNote: type: string groupLevel: type: integer relationships: type: object properties: subscriptionLocalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - subscriptionLocalizations id: type: string required: - id - type appStoreReviewScreenshot: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - subscriptionAppStoreReviewScreenshots id: type: string required: - id - type group: type: object properties: data: type: object properties: type: type: string enum: - subscriptionGroups id: type: string required: - id - type introductoryOffers: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - subscriptionIntroductoryOffers id: type: string required: - id - type promotionalOffers: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - subscriptionPromotionalOffers id: type: string required: - id - type offerCodes: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - subscriptionOfferCodes id: type: string required: - id - type prices: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - subscriptionPrices id: type: string required: - id - type pricePoints: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' promotedPurchase: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - promotedPurchases id: type: string required: - id - type subscriptionAvailability: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - subscriptionAvailabilities id: type: string required: - id - type winBackOffers: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - winBackOffers id: type: string required: - id - type images: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - subscriptionImages id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type InAppPurchaseAppStoreReviewScreenshotResponse: type: object title: InAppPurchaseAppStoreReviewScreenshotResponse properties: data: $ref: '#/components/schemas/InAppPurchaseAppStoreReviewScreenshot' included: type: array items: $ref: '#/components/schemas/InAppPurchaseV2' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links InAppPurchaseState: type: string enum: - MISSING_METADATA - WAITING_FOR_UPLOAD - PROCESSING_CONTENT - READY_TO_SUBMIT - WAITING_FOR_REVIEW - IN_REVIEW - DEVELOPER_ACTION_NEEDED - PENDING_BINARY_APPROVAL - APPROVED - DEVELOPER_REMOVED_FROM_SALE - REMOVED_FROM_SALE - REJECTED InAppPurchaseV2PricePointsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - inAppPurchasePricePoints id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links InAppPurchaseOfferCodesResponse: type: object title: InAppPurchaseOfferCodesResponse properties: data: type: array items: $ref: '#/components/schemas/InAppPurchaseOfferCode' included: type: array items: oneOf: - $ref: '#/components/schemas/InAppPurchaseOfferCodeCustomCode' - $ref: '#/components/schemas/InAppPurchaseOfferCodeOneTimeUseCode' - $ref: '#/components/schemas/InAppPurchaseOfferPrice' discriminator: propertyName: type mapping: inAppPurchaseOfferPrices: '#/components/schemas/InAppPurchaseOfferPrice' inAppPurchaseOfferCodeOneTimeUseCodes: '#/components/schemas/InAppPurchaseOfferCodeOneTimeUseCode' inAppPurchaseOfferCodeCustomCodes: '#/components/schemas/InAppPurchaseOfferCodeCustomCode' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppMediaStateError: type: object properties: code: type: string description: type: string InAppPurchaseType: type: string enum: - CONSUMABLE - NON_CONSUMABLE - NON_RENEWING_SUBSCRIPTION Territory: type: object title: Territory properties: type: type: string enum: - territories id: type: string attributes: type: object properties: currency: type: string links: $ref: '#/components/schemas/ResourceLinks' required: - id - type InAppPurchaseAppStoreReviewScreenshot: type: object title: InAppPurchaseAppStoreReviewScreenshot properties: type: type: string enum: - inAppPurchaseAppStoreReviewScreenshots id: type: string attributes: type: object properties: fileSize: type: integer fileName: type: string sourceFileChecksum: type: string imageAsset: $ref: '#/components/schemas/ImageAsset' assetToken: type: string assetType: type: string uploadOperations: type: array items: $ref: '#/components/schemas/UploadOperation' assetDeliveryState: $ref: '#/components/schemas/AppMediaAssetState' relationships: type: object properties: inAppPurchaseV2: type: object properties: data: type: object properties: type: type: string enum: - inAppPurchases id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type InAppPurchaseV2PromotedPurchaseLinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - promotedPurchases id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links HttpHeader: type: object properties: name: type: string value: type: string securitySchemes: itc-bearer-token: type: http scheme: bearer bearerFormat: JWT