PAY.JP · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for PAY.JP Statements API

4 actions 4 updates phrasing extends openapi/payjp-statements-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 4

$.info
$.paths['/statements'].get
$.paths['/statements/{id}'].get
$.paths['/statements/{id}/statement_urls'].post

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 Statements API
  version: 1.0.0
extends: openapi/payjp-statements-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['/statements'].get
  update:
    x-apievangelist-phrasing:
      intent: List transaction statements
      effect: read
      questions:
      - How do I see my transaction statements?
      - Which statements are available for my account?
      instructions:
      - text: List my transaction statements.
      - text: Show all my statements.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/statements/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transaction statement
      effect: read
      questions:
      - How do I view the line items in one statement?
      - What's included in a specific transaction statement?
      instructions:
      - text: Show statement {id}.
        slots:
          id: path.id
      - text: Get the details of transaction statement {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/statements/{id}/statement_urls'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a CSV download link for a statement
      effect: write
      questions:
      - Can I download a statement as a CSV file?
      - How do I get a signed link to export a statement?
      instructions:
      - text: Create a CSV download URL for statement {id}.
        slots:
          id: path.id
      - text: Give me a signed link to download statement {id} as CSV.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'