# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Thehiveryiq Com Subscription API
  version: 1.0.0
extends: openapi/thehiveryiq-com-subscription-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v1/subscription/plans'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscription plans
      effect: read
      questions:
      - What subscription plans are offered and what do they cost?
      - Which payment rails can I use to pay for a plan?
      instructions:
      - text: List the subscription plans.
      - text: Show plan prices and features.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/subscription/intent'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a subscription and get payment instructions
      effect: write
      questions:
      - How do I sign up for the dev-pack or saas-pro plan?
      - What payment instructions and memo do I get when I pick a plan?
      instructions:
      - text: Start a {plan} subscription.
        slots:
          plan: requestBody.plan
      - text: Subscribe {email} to the {plan} plan and give me payment instructions.
        slots:
          email: requestBody.email
          plan: requestBody.plan
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/subscription/claim'].post
  update:
    x-apievangelist-phrasing:
      intent: Claim a subscription with a payment tx hash
      effect: write
      questions:
      - How do I activate my subscription after paying on-chain?
      - Is my transaction hash verified on-chain when I claim a subscription?
      instructions:
      - text: Claim subscription {sub_id} with transaction {tx_hash}.
        slots:
          sub_id: requestBody.sub_id
          tx_hash: requestBody.tx_hash
      - text: Activate {sub_id} using payment hash {tx_hash}.
        slots:
          sub_id: requestBody.sub_id
          tx_hash: requestBody.tx_hash
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/subscription/status/{sub_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a subscription's status
      effect: read
      questions:
      - How do I check whether my subscription has been provisioned?
      - Does the subscription status check return my API key?
      instructions:
      - text: Check the status of subscription {sub_id}.
        slots:
          sub_id: path.sub_id
      - text: Is subscription {sub_id} active yet.
        slots:
          sub_id: path.sub_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/subscription/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check subscription service health
      effect: read
      questions:
      - Is the subscription service up?
      - Can I confirm subscription signup is working before I pay?
      instructions:
      - text: Check subscription service health.
      - text: Ping the subscription service.
      method: generated
      generated: '2026-09-26'