# 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 Subscription Offer Codes API
  version: 1.0.0
extends: openapi/ios-subscriptionoffercodes-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: 9
- target: $.paths['/v1/subscriptionOfferCodes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a subscription offer code campaign
      effect: write
      questions:
      - How do I create an offer code campaign for an auto-renewable subscription?
      - Can I set territory prices when creating a subscription offer code?
      instructions:
      - text: Create a subscription offer code from {offer}.
        slots:
          offer: requestBody.data
      - text: Set up an offer code campaign {offer} with prices {prices}.
        slots:
          offer: requestBody.data
          prices: requestBody.included
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptionOfferCodes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription offer code
      effect: read
      questions:
      - What are the eligibility and duration settings of one of my offer codes?
      - Can I look up a subscription offer code by its ID?
      instructions:
      - text: Show subscription offer code {id}.
        slots:
          id: path.id
      - text: Fetch the settings of offer code campaign {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptionOfferCodes/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a subscription offer code
      effect: write
      questions:
      - Can I turn off an active subscription offer code?
      - What can I change on an offer code campaign after it is created?
      instructions:
      - text: Update subscription offer code {id} with {changes}.
        slots:
          id: path.id
          changes: requestBody.data
      - text: Deactivate offer code campaign {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptionOfferCodes/{id}/relationships/customCodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom code IDs for an offer
      effect: read
      questions:
      - Which custom code IDs belong to my subscription offer?
      - Can I get just the identifiers of an offer's custom codes?
      instructions:
      - text: List the custom code IDs linked to offer code {id}.
        slots:
          id: path.id
      - text: Return only custom code references for offer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptionOfferCodes/{id}/customCodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List an offer's custom codes
      effect: read
      questions:
      - What custom codes like SUMMER2026 exist for my subscription offer?
      - Can I see the redemption limits and expiry of each custom code on an offer?
      instructions:
      - text: Show the full custom codes for subscription offer code {id}.
        slots:
          id: path.id
      - text: List up to {limit} custom codes with their details for offer {id}.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptionOfferCodes/{id}/relationships/oneTimeUseCodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List one-time code batch IDs for an offer
      effect: read
      questions:
      - Which one-time-use code batch IDs are attached to my offer?
      - Can I fetch only identifiers for an offer's one-time-use codes?
      instructions:
      - text: List the one-time-use code batch IDs linked to offer code {id}.
        slots:
          id: path.id
      - text: Return only single-use batch references for offer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptionOfferCodes/{id}/oneTimeUseCodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List an offer's one-time-use code batches
      effect: read
      questions:
      - How many one-time-use code batches have I generated for an offer, and when do they expire?
      - Where do I see each batch of single-use codes for a subscription offer?
      instructions:
      - text: Show the full one-time-use code batches for offer code {id}.
        slots:
          id: path.id
      - text: List single-use code batches with counts and expiry for offer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptionOfferCodes/{id}/relationships/prices'].get
  update:
    x-apievangelist-phrasing:
      intent: List price IDs for an offer code
      effect: read
      questions:
      - Which price IDs are set on my subscription offer code?
      - Can I get only the identifiers of an offer code's territory prices?
      instructions:
      - text: List the price IDs linked to offer code {id}.
        slots:
          id: path.id
      - text: Return only price references for offer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptionOfferCodes/{id}/prices'].get
  update:
    x-apievangelist-phrasing:
      intent: List an offer code's prices by territory
      effect: read
      questions:
      - What does my subscription offer code cost in each country?
      - Can I check an offer code's price for a single territory?
      instructions:
      - text: Show the full prices for offer code {id}.
        slots:
          id: path.id
      - text: Get offer code {id}'s price in territory {territory}.
        slots:
          id: path.id
          territory: query.filter[territory]
      method: generated
      generated: '2026-10-01'