iOS

iOS InAppPurchaseOfferCodes API

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

GitHub OpenAPI
Business capability
Discount & Promotion Management BC-440.30

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v1/inAppPurchaseOfferCodes Create an offer code for an in-app purchase · Create in App Purchase Offer Codes #
Ask an LLM
“How do I create a promotional offer code campaign for an in-app purchase?”
“Can I set up offer codes for a one-time in-app purchase, not just subscriptions?”
Tell an agent
Create an in-app purchase offer code with {offer}.
Set up a new offer code campaign for my in-app purchase using {offer}.
GET /v1/inAppPurchaseOfferCodes/{id} Get an in-app purchase offer code · Get in App Purchase Offer Codes #
Ask an LLM
“What are the settings of one in-app purchase offer code, like eligibility and status?”
“Can I fetch an offer code along with its custom codes and prices?”
Tell an agent
Get in-app purchase offer code {offer}.
Fetch offer code {offer} and include {include}.
PATCH /v1/inAppPurchaseOfferCodes/{id} Update an in-app purchase offer code · Update in App Purchase Offer Codes #
Ask an LLM
“How do I turn off or change an existing in-app purchase offer code?”
“Can I edit an offer code after it's been created?”
Tell an agent
Update in-app purchase offer code {offer} with {changes}.
Deactivate offer code {offer} by setting {changes}.
GET /v1/inAppPurchaseOfferCodes/{id}/relationships/customCodes List custom code IDs for an offer code · List Related in App Purchase Offer Codes / Custom Codes #
Ask an LLM
“Which custom code IDs belong to an in-app purchase offer code?”
“Can I get just the identifiers of an offer's vanity codes?”
Tell an agent
List only the custom code IDs under offer code {offer}.
Return up to {limit} custom code identifiers for offer {offer}.
GET /v1/inAppPurchaseOfferCodes/{id}/customCodes List custom codes for an in-app purchase offer · List Related in App Purchase Offer Codes / Custom Codes #
Ask an LLM
“What custom, human-readable codes have I created for an in-app purchase offer, and how many redemptions does each allow?”
“Can I see the full details and expiration of each custom code under an offer?”
Tell an agent
Show the full custom codes, with expiry and quantity, for offer code {offer}.
Fetch the vanity codes defined for in-app purchase offer {offer}.
GET /v1/inAppPurchaseOfferCodes/{id}/relationships/oneTimeUseCodes List one-time-use code batch IDs for an offer · List Related in App Purchase Offer Codes / One Time Use Codes #
Ask an LLM
“Which one-time-use code batch IDs exist for an in-app purchase offer?”
“Can I get only the IDs of generated single-use code sets?”
Tell an agent
List only the one-time-use code batch IDs for offer {offer}.
Return up to {limit} single-use code set identifiers for offer code {offer}.
GET /v1/inAppPurchaseOfferCodes/{id}/oneTimeUseCodes List one-time-use code batches for an offer · List Related in App Purchase Offer Codes / One Time Use Codes #
Ask an LLM
“What batches of single-use redemption codes have been generated for an in-app purchase offer?”
“Can I see how many one-time codes were generated in each batch and when they expire?”
Tell an agent
Show the full one-time-use code batches for offer code {offer}.
Fetch details of every single-use code set generated for offer {offer}.
GET /v1/inAppPurchaseOfferCodes/{id}/relationships/prices List price IDs for an in-app purchase offer code · List Related in App Purchase Offer Codes / Prices #
Ask an LLM
“Which price record IDs are attached to an in-app purchase offer code?”
“Can I get only the identifiers of an offer's territory prices?”
Tell an agent
List only the price IDs for offer code {offer}.
Return up to {limit} price identifiers attached to offer {offer}.
GET /v1/inAppPurchaseOfferCodes/{id}/prices List territory prices for an offer code · List Related in App Purchase Offer Codes / Prices #
Ask an LLM
“What does an in-app purchase offer code cost in each territory?”
“Can I check an offer code's price for just one country or region?”
Tell an agent
Show the full territory prices for offer code {offer}.
Get the price of offer {offer} in territory {territory}.

Documentation

📖
Documentation
https://developer.apple.com/documentation/appstoreconnectapi
📖
APIReference
https://developer.apple.com/documentation/appstoreconnectapi
📖
GettingStarted
https://developer.apple.com/documentation/appstoreconnectapi/creating-api-keys-for-app-store-connect-api
📖
Authentication
https://developer.apple.com/documentation/appstoreconnectapi/generating-tokens-for-api-requests

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ios/refs/heads/main/openapi/ios-inapppurchaseoffercodes-api-openapi.yml

Other Resources

🔗
ReleaseNotes
https://developer.apple.com/documentation/appstoreconnectapi/app-store-connect-api-release-notes
🔗
SDKs
https://github.com/apple/app-store-server-library-swift
🔗
SDKs
https://github.com/apple/app-store-server-library-java
🔗
SDKs
https://github.com/apple/app-store-server-library-python
🔗
SDKs
https://github.com/apple/app-store-server-library-node

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/ios:ios-inapppurchaseoffercodes-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ios-inapppurchaseoffercodes-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: App Store Connect In App Purchase Offer Codes 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.
servers:
- url: https://api.appstoreconnect.apple.com/
security:
- itc-bearer-token: []
tags:


# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ios/refs/heads/main/openapi/ios-inapppurchaseoffercodes-api-openapi.yml