Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Balance API

4 actions 4 updates phrasing extends openapi/stripe-balance-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Stripe's API. It is a proposal applied on top of the contract, not a document Stripe publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/v1/balance'].get
$.paths['/v1/balance/history'].get
$.paths['/v1/balance/history/{id}'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stripe Balance API
  version: 1.0.0
extends: openapi/stripe-balance-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: 3
- target: $.paths['/v1/balance'].get
  update:
    x-apievangelist-phrasing:
      intent: Check my account balance
      effect: read
      questions:
      - How much money is currently in my Stripe balance?
      - How much of my balance is available versus still pending?
      instructions:
      - text: Show my current account balance.
      - text: Tell me how much of my balance is available versus pending.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/balance/history'].get
  update:
    x-apievangelist-phrasing:
      intent: List balance transactions
      effect: read
      questions:
      - How do I see every transaction that changed my balance?
      - Can I list which transactions were included in a specific payout?
      - Can I filter balance history by type, like only refunds or fees?
      instructions:
      - text: List my balance transactions.
      - text: List balance transactions included in payout {payout}.
        slots:
          payout: query.payout
      - text: Show balance transactions of type {type} in {currency}.
        slots:
          type: query.type
          currency: query.currency
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/balance/history/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a balance transaction
      effect: read
      questions:
      - How do I see the fee and net amount for one balance transaction?
      - Can I look up a single entry in my balance history?
      instructions:
      - text: Get balance transaction {id}.
        slots:
          id: path.id
      - text: Show the fees and net amount for balance transaction {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'