# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stripe Refunds API
  version: 1.0.0
extends: openapi/stripe-refunds-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/refunds'].get
  update:
    x-apievangelist-phrasing:
      intent: List refunds
      effect: read
      questions:
      - How do I see all the refunds I've issued?
      - Can I list refunds for just one charge or PaymentIntent?
      instructions:
      - text: List my most recent refunds.
      - text: List refunds for payment {payment_intent}.
        slots:
          payment_intent: query.payment_intent
      - text: Show refunds issued on charge {charge}.
        slots:
          charge: query.charge
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/refunds'].post
  update:
    x-apievangelist-phrasing:
      intent: Refund a payment
      effect: write
      questions:
      - How do I refund a customer's payment?
      - Can I give a partial refund instead of refunding the whole charge?
      - Can I record why I'm refunding, like a duplicate or fraudulent charge?
      instructions:
      - text: Refund payment {payment_intent} in full.
        slots:
          payment_intent: requestBody.payment_intent
      - text: Refund {amount} of payment {payment_intent}.
        slots:
          amount: requestBody.amount
          payment_intent: requestBody.payment_intent
      - text: Refund charge {charge} with reason {reason}.
        slots:
          charge: requestBody.charge
          reason: requestBody.reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/refunds/{refund}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a refund
      effect: read
      questions:
      - How do I check the status of a refund?
      - Has a specific refund gone through yet?
      instructions:
      - text: Get refund {refund}.
        slots:
          refund: path.refund
      - text: Show the current status of refund {refund}.
        slots:
          refund: path.refund
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/refunds/{refund}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a refund's metadata
      effect: write
      questions:
      - Can I add my own reference data to a refund I already issued?
      - What can I change on a refund after it's created?
      instructions:
      - text: Update the metadata on refund {refund} to {metadata}.
        slots:
          refund: path.refund
          metadata: requestBody.metadata
      - text: Tag refund {refund} with {metadata}.
        slots:
          refund: path.refund
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/refunds/{refund}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a pending refund
      effect: destructive
      questions:
      - How do I cancel a refund that's waiting on customer action?
      - Can I cancel a refund after it has already succeeded?
      instructions:
      - text: Cancel refund {refund}.
        slots:
          refund: path.refund
      - text: Stop refund {refund} while it still requires action.
        slots:
          refund: path.refund
      method: generated
      generated: '2026-09-26'