PAY.JP · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for PAY.JP Balances API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/balances'].get
$.paths['/balances/{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 PAY.JP Balances API
  version: 1.0.0
extends: openapi/payjp-balances-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: 2
- target: $.paths['/balances'].get
  update:
    x-apievangelist-phrasing:
      intent: List account balances
      effect: read
      questions:
      - What balances do I have accumulating on my account?
      - Can I see a list of all my balance records?
      instructions:
      - text: List my account balances.
      - text: Show every balance on my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/balances/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single balance
      effect: read
      questions:
      - How do I look up the details of one specific balance?
      - What's in a particular balance record?
      instructions:
      - text: Show balance {id}.
        slots:
          id: path.id
      - text: Get the details of balance {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'