# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ThriveCart Subscriptions API
  version: 1.0.0
extends: openapi/thrivecart-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: 4
- target: $.paths['/cancelSubscription'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a subscription
      effect: destructive
      questions:
      - How do I cancel a customer's recurring subscription?
      - Which IDs do I need to cancel a subscription?
      instructions:
      - text: Cancel subscription {subscription_id} on order {order_id}.
        slots:
          subscription_id: requestBody.subscription_id
          order_id: requestBody.order_id
      - text: Stop billing for subscription {subscription_id} from order {order_id} permanently.
        slots:
          subscription_id: requestBody.subscription_id
          order_id: requestBody.order_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/refund'].post
  update:
    x-apievangelist-phrasing:
      intent: Refund a transaction
      effect: destructive
      questions:
      - How do I refund a customer's purchase?
      - Can I refund a single item from an order by its reference?
      instructions:
      - text: Refund item {reference} on order {order_id}.
        slots:
          reference: requestBody.reference
          order_id: requestBody.order_id
      - text: Issue a refund for order {order_id}, purchase reference {reference}.
        slots:
          order_id: requestBody.order_id
          reference: requestBody.reference
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pauseSubscription'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause a subscription
      effect: write
      questions:
      - How do I put a customer's subscription on hold?
      - Can a paused subscription resume automatically on a set date?
      instructions:
      - text: Pause subscription {subscription_id} on order {order_id} indefinitely.
        slots:
          subscription_id: requestBody.subscription_id
          order_id: requestBody.order_id
      - text: Pause subscription {subscription_id} on order {order_id} and auto-resume at {auto_resume}.
        slots:
          subscription_id: requestBody.subscription_id
          order_id: requestBody.order_id
          auto_resume: requestBody.auto_resume
      method: generated
      generated: '2026-10-01'
- target: $.paths['/resumeSubscription'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused subscription
      effect: write
      questions:
      - How do I restart a subscription I paused?
      - Can I unpause a customer's subscription right away?
      instructions:
      - text: Resume subscription {subscription_id} on order {order_id}.
        slots:
          subscription_id: requestBody.subscription_id
          order_id: requestBody.order_id
      - text: Unpause subscription {subscription_id} from order {order_id} now.
        slots:
          subscription_id: requestBody.subscription_id
          order_id: requestBody.order_id
      method: generated
      generated: '2026-10-01'