iOS

iOS Subscriptions API

The Subscriptions API from iOS — 24 operation(s) for subscriptions.

GitHub OpenAPI
Business capability
Plan & Entitlement Design BC-4240.10

Operations 28

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/subscriptions Create an auto-renewable subscription · Create Subscriptions #
Ask an LLM
“How do I add a new auto-renewable subscription product to my app in App Store Connect?”
“Can I create a subscription inside an existing subscription group?”
Tell an agent
Create a new auto-renewable subscription in my subscription group.
Create a subscription product from these settings: {subscription_details}.
GET /v1/subscriptions/{id} Get a subscription's details · Get Subscriptions #
Ask an LLM
“What are the current settings of one of my auto-renewable subscriptions?”
“Where can I look up a subscription product's name, period and review state?”
Tell an agent
Show me the details of subscription {subscription}.
Fetch subscription {subscription} and its product settings.
PATCH /v1/subscriptions/{id} Update a subscription · Update Subscriptions #
Ask an LLM
“How do I change the name or duration of an existing subscription product?”
“Can I edit a subscription's settings after creating it?”
Tell an agent
Update subscription {subscription} with a new reference name.
Change the subscription period on subscription {subscription}.
DELETE /v1/subscriptions/{id} Delete a subscription · Delete Subscriptions #
Ask an LLM
“Can I remove a subscription product that I no longer want to offer?”
“Is it possible to delete an auto-renewable subscription I created by mistake?”
Tell an agent destructive · confirm first
Delete subscription {subscription}.
Remove the subscription product {subscription} from my app.
GET /v1/subscriptions/{id}/relationships/appStoreReviewScreenshot Get the review screenshot ID linked to a subscription · Get Related Subscriptions / App Store Review Screenshot #
Ask an LLM
“Which review screenshot ID is attached to my subscription?”
“Is there a review screenshot linked to this subscription at all, just the reference?”
Tell an agent
Get only the linked review screenshot ID for subscription {subscription}.
Check whether subscription {subscription} has a review screenshot reference.
GET /v1/subscriptions/{id}/appStoreReviewScreenshot Get the App Review screenshot for a subscription · Get Related Subscriptions / App Store Review Screenshot #
Ask an LLM
“How do I see the screenshot I uploaded for App Review on a subscription?”
“What image file and upload state does my subscription's review screenshot have?”
Tell an agent
Show the full App Review screenshot record for subscription {subscription}.
Fetch the review screenshot details uploaded for subscription {subscription}.
GET /v1/subscriptions/{id}/relationships/images List image IDs linked to a subscription · List Related Subscriptions / Images #
Ask an LLM
“Which promotional image IDs are linked to my subscription?”
“Can I get just the references to a subscription's images without their details?”
Tell an agent
List only the image IDs linked to subscription {subscription}.
Get up to {limit} image references for subscription {subscription}.
GET /v1/subscriptions/{id}/images List a subscription's promotional images · List Related Subscriptions / Images #
Ask an LLM
“How do I see all the promotional images uploaded for a subscription?”
“What upload state are my subscription's images in?”
Tell an agent
Show the full image records for subscription {subscription}.
List the first {limit} promotional images of subscription {subscription} with details.
GET /v1/subscriptions/{id}/relationships/introductoryOffers List introductory offer IDs on a subscription · List Related Subscriptions / Introductory Offers #
Ask an LLM
“Which introductory offer IDs are attached to my subscription?”
“Can I fetch only the linkage of intro offers for a subscription?”
Tell an agent
List only the introductory offer IDs for subscription {subscription}.
Get up to {limit} intro offer references on subscription {subscription}.
DELETE /v1/subscriptions/{id}/relationships/introductoryOffers Remove introductory offers from a subscription · Remove Related Subscriptions / Introductory Offers #
Ask an LLM
“How do I remove free-trial or intro pricing offers from a subscription?”
“Can I delete several introductory offers from a subscription at once?”
Tell an agent destructive · confirm first
Remove the selected introductory offers from subscription {subscription}.
Take the intro offers off subscription {subscription}.
GET /v1/subscriptions/{id}/introductoryOffers List a subscription's introductory offers · List Related Subscriptions / Introductory Offers #
Ask an LLM
“What free trials or intro prices are set up for my subscription?”
“Can I see the introductory offers for a subscription in one specific country?”
Tell an agent
Show the introductory offers for subscription {subscription} with their details.
List intro offers for subscription {subscription} in territory {territory}.
GET /v1/subscriptions/{id}/relationships/offerCodes List offer code IDs on a subscription · List Related Subscriptions / Offer Codes #
Ask an LLM
“Which offer code IDs belong to my subscription?”
“Can I get just references to a subscription's offer codes?”
Tell an agent
List only the offer code IDs for subscription {subscription}.
Get up to {limit} offer code references on subscription {subscription}.
GET /v1/subscriptions/{id}/offerCodes List a subscription's offer codes · List Related Subscriptions / Offer Codes #
Ask an LLM
“What offer code campaigns have I created for a subscription?”
“Can I see the offer codes available for a subscription in a particular territory?”
Tell an agent
Show the offer codes for subscription {subscription} with their details.
List offer codes on subscription {subscription} available in {territory}.
GET /v1/subscriptions/{id}/relationships/pricePoints List price point IDs for a subscription · List Related Subscriptions / Price Points #
Ask an LLM
“Which price point IDs are available to my subscription?”
“Can I fetch only the price point references for a subscription?”
Tell an agent
List only the price point IDs for subscription {subscription}.
Get up to {limit} price point references for subscription {subscription}.
GET /v1/subscriptions/{id}/pricePoints List the price points a subscription can use · List Related Subscriptions / Price Points #
Ask an LLM
“What price tiers can I choose from for my subscription?”
“Which customer prices and proceeds are possible for a subscription in a given country?”
Tell an agent
Show the available price points for subscription {subscription}.
List price points for subscription {subscription} in territory {territory}.
GET /v1/subscriptions/{id}/relationships/prices List price IDs set on a subscription · List Related Subscriptions / Prices #
Ask an LLM
“Which price record IDs are attached to my subscription?”
“Can I get just the references to a subscription's scheduled prices?”
Tell an agent
List only the price IDs set on subscription {subscription}.
Fetch {limit} current price record IDs on subscription {subscription}.
DELETE /v1/subscriptions/{id}/relationships/prices Remove prices from a subscription · Remove Related Subscriptions / Prices #
Ask an LLM
“How do I remove a scheduled price change from my subscription?”
“Can I delete specific prices that are set on a subscription?”
Tell an agent destructive · confirm first
Remove the selected prices from subscription {subscription}.
Delete the scheduled price entries on subscription {subscription}.
GET /v1/subscriptions/{id}/prices List a subscription's prices · List Related Subscriptions / Prices #
Ask an LLM
“What is my subscription currently priced at in each country?”
“Can I see the prices on a subscription for one territory or one price point?”
Tell an agent
Show the prices set on subscription {subscription}.
List the prices of subscription {subscription} in territory {territory}.
GET /v1/subscriptions/{id}/relationships/promotedPurchase Get the promoted purchase ID for a subscription · Get Related Subscriptions / Promoted Purchase #
Ask an LLM
“Which promoted purchase ID is linked to my subscription?”
“Is my subscription referenced by a promoted in-app purchase, just the ID?”
Tell an agent
Get only the promoted purchase ID for subscription {subscription}.
Check which promoted purchase reference subscription {subscription} has.
GET /v1/subscriptions/{id}/promotedPurchase Get a subscription's promoted purchase · Get Related Subscriptions / Promoted Purchase #
Ask an LLM
“How do I see whether my subscription is promoted on the App Store product page?”
“What visibility and state does the promoted purchase for my subscription have?”
Tell an agent
Show the promoted purchase details for subscription {subscription}.
Fetch the full App Store promotion record of subscription {subscription}.
GET /v1/subscriptions/{id}/relationships/promotionalOffers List promotional offer IDs on a subscription · List Related Subscriptions / Promotional Offers #
Ask an LLM
“Which promotional offer IDs exist for my subscription?”
“Can I get only the references to a subscription's promotional offers?”
Tell an agent
List only the promotional offer IDs for subscription {subscription}.
Get up to {limit} promotional offer references on subscription {subscription}.
GET /v1/subscriptions/{id}/promotionalOffers List a subscription's promotional offers · List Related Subscriptions / Promotional Offers #
Ask an LLM
“What promotional offers have I set up to win or keep existing subscribers?”
“Can I see the promotional offers on a subscription for a single territory?”
Tell an agent
Show the promotional offers for subscription {subscription} with details.
List promotional offers on subscription {subscription} in {territory}.
GET /v1/subscriptions/{id}/relationships/subscriptionAvailability Get the availability ID for a subscription · Get Related Subscriptions / Subscription Availability #
Ask an LLM
“Which availability record ID is linked to my subscription?”
“Can I get just the reference to a subscription's availability settings?”
Tell an agent
Get only the availability ID for subscription {subscription}.
Check the availability reference linked to subscription {subscription}.
GET /v1/subscriptions/{id}/subscriptionAvailability Get where a subscription is available · Get Related Subscriptions / Subscription Availability #
Ask an LLM
“In which countries is my subscription available for sale?”
“Does my subscription automatically become available in new territories?”
Tell an agent
Show the availability settings for subscription {subscription}.
Fetch which territories subscription {subscription} is sold in.
GET /v1/subscriptions/{id}/relationships/subscriptionLocalizations List localization IDs for a subscription · List Related Subscriptions / Subscription Localizations #
Ask an LLM
“Which localization IDs are attached to my subscription?”
“Can I fetch just the references to a subscription's translations?”
Tell an agent
List only the localization IDs for subscription {subscription}.
Get up to {limit} localization references for subscription {subscription}.
GET /v1/subscriptions/{id}/subscriptionLocalizations List a subscription's localized names and descriptions · List Related Subscriptions / Subscription Localizations #
Ask an LLM
“What display names and descriptions does my subscription show in each language?”
“Which languages has my subscription been localized into?”
Tell an agent
Show the localized names and descriptions of subscription {subscription}.
List the first {limit} localizations of subscription {subscription} with text.
GET /v1/subscriptions/{id}/relationships/winBackOffers List win-back offer IDs for a subscription · List Related Subscriptions / Win Back Offers #
Ask an LLM
“Which win-back offer IDs are linked to my subscription?”
“Can I get only references to the win-back offers on a subscription?”
Tell an agent
List only the win-back offer IDs for subscription {subscription}.
Get up to {limit} win-back offer references on subscription {subscription}.
GET /v1/subscriptions/{id}/winBackOffers List a subscription's win-back offers · List Related Subscriptions / Win Back Offers #
Ask an LLM
“What win-back offers do I have to bring lapsed subscribers back?”
“How do I review the eligibility and pricing of my subscription's win-back offers?”
Tell an agent
Show the win-back offers for subscription {subscription} with their details.
List the first {limit} win-back offers for lapsed subscribers of {subscription}.

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://artifacts.apis.io/ios/openapi/ios-subscriptions-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-subscriptions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-subscriptions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: App Store Connect Subscriptions 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 (152 KB total) ---
# Full source: https://artifacts.apis.io/ios/openapi/ios-subscriptions-api-openapi.yml