# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stripe Topups API
  version: 1.0.0
extends: openapi/stripe-topups-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/topups'].get
  update:
    x-apievangelist-phrasing:
      intent: List balance top-ups
      effect: read
      questions:
      - How do I see every time I've added funds to my account balance?
      - Can I list only pending or failed top-ups?
      instructions:
      - text: List my recent top-ups.
      - text: List top-ups with status {status}.
        slots:
          status: query.status
      - text: Show top-ups created in {created}.
        slots:
          created: query.created
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/topups'].post
  update:
    x-apievangelist-phrasing:
      intent: Add funds to the account balance
      effect: write
      questions:
      - How do I add money to my balance so I can cover payouts or refunds?
      - Can I choose which source the top-up pulls funds from?
      - Can I set what appears on the bank statement for a top-up?
      instructions:
      - text: Top up my balance with {amount} {currency}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
      - text: Add {amount} {currency} to my balance from source {source}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          source: requestBody.source
      - text: Top up {amount} {currency} with statement descriptor {statement_descriptor}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          statement_descriptor: requestBody.statement_descriptor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/topups/{topup}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a top-up
      effect: read
      questions:
      - How do I check whether a specific top-up has succeeded?
      - What amount and source were used for one top-up?
      instructions:
      - text: Get top-up {topup}.
        slots:
          topup: path.topup
      - text: Show me the status of top-up {topup}.
        slots:
          topup: path.topup
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/topups/{topup}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a top-up's description
      effect: write
      questions:
      - Can I change the description or metadata on a top-up?
      - Which details of a top-up can be edited after it's created?
      instructions:
      - text: Set the description of top-up {topup} to {description}.
        slots:
          topup: path.topup
          description: requestBody.description
      - text: Add metadata {metadata} to top-up {topup}.
        slots:
          metadata: requestBody.metadata
          topup: path.topup
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/topups/{topup}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a pending top-up
      effect: destructive
      questions:
      - How do I cancel a top-up I started by mistake?
      - Can I cancel a top-up that has already completed?
      instructions:
      - text: Cancel top-up {topup}.
        slots:
          topup: path.topup
      - text: Stop pending top-up {topup} before it completes.
        slots:
          topup: path.topup
      method: generated
      generated: '2026-09-26'