# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for App Store Connect Subscriptions API version: 1.0.0 extends: openapi/ios-subscriptions-api-openapi.yml actions: - target: $.info update: x-apievangelist-phrasing: method: generated generated: '2026-10-01' generator: build-phrasing.py label: Generated by API Evangelist operations: 28 - target: $.paths['/v1/subscriptions'].post update: x-apievangelist-phrasing: intent: Create an auto-renewable subscription effect: write questions: - 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? instructions: - text: Create a new auto-renewable subscription in my subscription group. - text: 'Create a subscription product from these settings: {subscription_details}.' slots: subscription_details: requestBody.data method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}'].get update: x-apievangelist-phrasing: intent: Get a subscription's details effect: read questions: - 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? instructions: - text: Show me the details of subscription {subscription}. slots: subscription: path.id - text: Fetch subscription {subscription} and its product settings. slots: subscription: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a subscription effect: destructive questions: - 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? instructions: - text: Delete subscription {subscription}. slots: subscription: path.id - text: Remove the subscription product {subscription} from my app. slots: subscription: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}'].patch update: x-apievangelist-phrasing: intent: Update a subscription effect: write questions: - How do I change the name or duration of an existing subscription product? - Can I edit a subscription's settings after creating it? instructions: - text: Update subscription {subscription} with a new reference name. slots: subscription: path.id - text: Change the subscription period on subscription {subscription}. slots: subscription: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/relationships/appStoreReviewScreenshot'].get update: x-apievangelist-phrasing: intent: Get the review screenshot ID linked to a subscription effect: read questions: - Which review screenshot ID is attached to my subscription? - Is there a review screenshot linked to this subscription at all, just the reference? instructions: - text: Get only the linked review screenshot ID for subscription {subscription}. slots: subscription: path.id - text: Check whether subscription {subscription} has a review screenshot reference. slots: subscription: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/appStoreReviewScreenshot'].get update: x-apievangelist-phrasing: intent: Get the App Review screenshot for a subscription effect: read questions: - 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? instructions: - text: Show the full App Review screenshot record for subscription {subscription}. slots: subscription: path.id - text: Fetch the review screenshot details uploaded for subscription {subscription}. slots: subscription: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/relationships/images'].get update: x-apievangelist-phrasing: intent: List image IDs linked to a subscription effect: read questions: - Which promotional image IDs are linked to my subscription? - Can I get just the references to a subscription's images without their details? instructions: - text: List only the image IDs linked to subscription {subscription}. slots: subscription: path.id - text: Get up to {limit} image references for subscription {subscription}. slots: subscription: path.id limit: query.limit method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/images'].get update: x-apievangelist-phrasing: intent: List a subscription's promotional images effect: read questions: - How do I see all the promotional images uploaded for a subscription? - What upload state are my subscription's images in? instructions: - text: Show the full image records for subscription {subscription}. slots: subscription: path.id - text: List the first {limit} promotional images of subscription {subscription} with details. slots: subscription: path.id limit: query.limit method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/relationships/introductoryOffers'].get update: x-apievangelist-phrasing: intent: List introductory offer IDs on a subscription effect: read questions: - Which introductory offer IDs are attached to my subscription? - Can I fetch only the linkage of intro offers for a subscription? instructions: - text: List only the introductory offer IDs for subscription {subscription}. slots: subscription: path.id - text: Get up to {limit} intro offer references on subscription {subscription}. slots: subscription: path.id limit: query.limit method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/relationships/introductoryOffers'].delete update: x-apievangelist-phrasing: intent: Remove introductory offers from a subscription effect: destructive questions: - How do I remove free-trial or intro pricing offers from a subscription? - Can I delete several introductory offers from a subscription at once? instructions: - text: Remove the selected introductory offers from subscription {subscription}. slots: subscription: path.id - text: Take the intro offers off subscription {subscription}. slots: subscription: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/introductoryOffers'].get update: x-apievangelist-phrasing: intent: List a subscription's introductory offers effect: read questions: - 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? instructions: - text: Show the introductory offers for subscription {subscription} with their details. slots: subscription: path.id - text: List intro offers for subscription {subscription} in territory {territory}. slots: subscription: path.id territory: query.filter[territory] method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/relationships/offerCodes'].get update: x-apievangelist-phrasing: intent: List offer code IDs on a subscription effect: read questions: - Which offer code IDs belong to my subscription? - Can I get just references to a subscription's offer codes? instructions: - text: List only the offer code IDs for subscription {subscription}. slots: subscription: path.id - text: Get up to {limit} offer code references on subscription {subscription}. slots: subscription: path.id limit: query.limit method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/offerCodes'].get update: x-apievangelist-phrasing: intent: List a subscription's offer codes effect: read questions: - What offer code campaigns have I created for a subscription? - Can I see the offer codes available for a subscription in a particular territory? instructions: - text: Show the offer codes for subscription {subscription} with their details. slots: subscription: path.id - text: List offer codes on subscription {subscription} available in {territory}. slots: subscription: path.id territory: query.filter[territory] method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/relationships/pricePoints'].get update: x-apievangelist-phrasing: intent: List price point IDs for a subscription effect: read questions: - Which price point IDs are available to my subscription? - Can I fetch only the price point references for a subscription? instructions: - text: List only the price point IDs for subscription {subscription}. slots: subscription: path.id - text: Get up to {limit} price point references for subscription {subscription}. slots: subscription: path.id limit: query.limit method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/pricePoints'].get update: x-apievangelist-phrasing: intent: List the price points a subscription can use effect: read questions: - What price tiers can I choose from for my subscription? - Which customer prices and proceeds are possible for a subscription in a given country? instructions: - text: Show the available price points for subscription {subscription}. slots: subscription: path.id - text: List price points for subscription {subscription} in territory {territory}. slots: subscription: path.id territory: query.filter[territory] method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/relationships/prices'].get update: x-apievangelist-phrasing: intent: List price IDs set on a subscription effect: read questions: - Which price record IDs are attached to my subscription? - Can I get just the references to a subscription's scheduled prices? instructions: - text: List only the price IDs set on subscription {subscription}. slots: subscription: path.id - text: Fetch {limit} current price record IDs on subscription {subscription}. slots: subscription: path.id limit: query.limit method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/relationships/prices'].delete update: x-apievangelist-phrasing: intent: Remove prices from a subscription effect: destructive questions: - How do I remove a scheduled price change from my subscription? - Can I delete specific prices that are set on a subscription? instructions: - text: Remove the selected prices from subscription {subscription}. slots: subscription: path.id - text: Delete the scheduled price entries on subscription {subscription}. slots: subscription: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/prices'].get update: x-apievangelist-phrasing: intent: List a subscription's prices effect: read questions: - 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? instructions: - text: Show the prices set on subscription {subscription}. slots: subscription: path.id - text: List the prices of subscription {subscription} in territory {territory}. slots: subscription: path.id territory: query.filter[territory] - text: Show prices on subscription {subscription} that use price point {price_point}. slots: subscription: path.id price_point: query.filter[subscriptionPricePoint] method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/relationships/promotedPurchase'].get update: x-apievangelist-phrasing: intent: Get the promoted purchase ID for a subscription effect: read questions: - Which promoted purchase ID is linked to my subscription? - Is my subscription referenced by a promoted in-app purchase, just the ID? instructions: - text: Get only the promoted purchase ID for subscription {subscription}. slots: subscription: path.id - text: Check which promoted purchase reference subscription {subscription} has. slots: subscription: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/promotedPurchase'].get update: x-apievangelist-phrasing: intent: Get a subscription's promoted purchase effect: read questions: - 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? instructions: - text: Show the promoted purchase details for subscription {subscription}. slots: subscription: path.id - text: Fetch the full App Store promotion record of subscription {subscription}. slots: subscription: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/relationships/promotionalOffers'].get update: x-apievangelist-phrasing: intent: List promotional offer IDs on a subscription effect: read questions: - Which promotional offer IDs exist for my subscription? - Can I get only the references to a subscription's promotional offers? instructions: - text: List only the promotional offer IDs for subscription {subscription}. slots: subscription: path.id - text: Get up to {limit} promotional offer references on subscription {subscription}. slots: subscription: path.id limit: query.limit method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/promotionalOffers'].get update: x-apievangelist-phrasing: intent: List a subscription's promotional offers effect: read questions: - 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? instructions: - text: Show the promotional offers for subscription {subscription} with details. slots: subscription: path.id - text: List promotional offers on subscription {subscription} in {territory}. slots: subscription: path.id territory: query.filter[territory] method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/relationships/subscriptionAvailability'].get update: x-apievangelist-phrasing: intent: Get the availability ID for a subscription effect: read questions: - Which availability record ID is linked to my subscription? - Can I get just the reference to a subscription's availability settings? instructions: - text: Get only the availability ID for subscription {subscription}. slots: subscription: path.id - text: Check the availability reference linked to subscription {subscription}. slots: subscription: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/subscriptionAvailability'].get update: x-apievangelist-phrasing: intent: Get where a subscription is available effect: read questions: - In which countries is my subscription available for sale? - Does my subscription automatically become available in new territories? instructions: - text: Show the availability settings for subscription {subscription}. slots: subscription: path.id - text: Fetch which territories subscription {subscription} is sold in. slots: subscription: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/relationships/subscriptionLocalizations'].get update: x-apievangelist-phrasing: intent: List localization IDs for a subscription effect: read questions: - Which localization IDs are attached to my subscription? - Can I fetch just the references to a subscription's translations? instructions: - text: List only the localization IDs for subscription {subscription}. slots: subscription: path.id - text: Get up to {limit} localization references for subscription {subscription}. slots: subscription: path.id limit: query.limit method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/subscriptionLocalizations'].get update: x-apievangelist-phrasing: intent: List a subscription's localized names and descriptions effect: read questions: - What display names and descriptions does my subscription show in each language? - Which languages has my subscription been localized into? instructions: - text: Show the localized names and descriptions of subscription {subscription}. slots: subscription: path.id - text: List the first {limit} localizations of subscription {subscription} with text. slots: subscription: path.id limit: query.limit method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/relationships/winBackOffers'].get update: x-apievangelist-phrasing: intent: List win-back offer IDs for a subscription effect: read questions: - Which win-back offer IDs are linked to my subscription? - Can I get only references to the win-back offers on a subscription? instructions: - text: List only the win-back offer IDs for subscription {subscription}. slots: subscription: path.id - text: Get up to {limit} win-back offer references on subscription {subscription}. slots: subscription: path.id limit: query.limit method: generated generated: '2026-10-01' - target: $.paths['/v1/subscriptions/{id}/winBackOffers'].get update: x-apievangelist-phrasing: intent: List a subscription's win-back offers effect: read questions: - 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? instructions: - text: Show the win-back offers for subscription {subscription} with their details. slots: subscription: path.id - text: List the first {limit} win-back offers for lapsed subscribers of {subscription}. slots: subscription: path.id limit: query.limit method: generated generated: '2026-10-01'