# 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 Promotional Offers API
  version: 1.0.0
extends: openapi/ios-subscriptionpromotionaloffers-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: 6
- target: $.paths['/v1/subscriptionPromotionalOffers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a subscription promotional offer
      effect: write
      questions:
      - How do I create a promotional offer for an auto-renewable subscription?
      - Can I set territory prices when creating a promo offer?
      instructions:
      - text: Create a subscription promotional offer with {data}.
        slots:
          data: requestBody.data
      - text: Set up a promo offer using {data} and the price records {included}.
        slots:
          data: requestBody.data
          included: requestBody.included
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptionPromotionalOffers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription promotional offer
      effect: read
      questions:
      - Can I look up a single promotional offer by ID?
      - What duration, mode and code does a promo offer have?
      instructions:
      - text: Show promotional offer {id}.
        slots:
          id: path.id
      - text: Fetch subscription promo offer {id} including {include}.
        slots:
          id: path.id
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptionPromotionalOffers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a subscription promotional offer
      effect: destructive
      questions:
      - How do I remove a promotional offer from a subscription?
      - Can I delete a promo offer I no longer want to give?
      instructions:
      - text: Delete promotional offer {id}.
        slots:
          id: path.id
      - text: Remove subscription promo offer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptionPromotionalOffers/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a promotional offer's prices
      effect: write
      questions:
      - Can I change the prices of an existing promotional offer?
      - How do I edit a subscription promo offer after it exists?
      instructions:
      - text: Update promotional offer {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Change promo offer {id} using {data} and new price records {included}.
        slots:
          id: path.id
          data: requestBody.data
          included: requestBody.included
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptionPromotionalOffers/{id}/relationships/prices'].get
  update:
    x-apievangelist-phrasing:
      intent: List IDs of a promo offer's prices
      effect: read
      questions:
      - Can I get just the price IDs attached to a promotional offer?
      - Which price identifiers belong to a promo offer?
      instructions:
      - text: Give me the price IDs for promotional offer {id}.
        slots:
          id: path.id
      - text: Return {limit} price linkages for promo offer {id}.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptionPromotionalOffers/{id}/prices'].get
  update:
    x-apievangelist-phrasing:
      intent: List a promo offer's prices by territory
      effect: read
      questions:
      - What does my promotional offer cost in each country?
      - Can I see a promo offer's price in one specific territory?
      instructions:
      - text: Show the prices for promotional offer {id}.
        slots:
          id: path.id
      - text: Show the price of promo offer {id} in territory {territory}.
        slots:
          id: path.id
          territory: query.filter[territory]
      method: generated
      generated: '2026-10-01'