PAY.JP · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for PAY.JP Terms API

3 actions 3 updates phrasing extends openapi/payjp-terms-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['/terms'].get

$.paths['/terms/{id}'].get

OpenAPI Overlay

# 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 Terms API
  version: 1.0.0
extends: openapi/payjp-terms-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['/terms'].get
  update:
    x-apievangelist-phrasing:
      intent: List aggregation terms
      effect: read
      questions:
      - How do I see the aggregation periods my sales are grouped into?
      - Which terms have been closed for my account?
      instructions:
      - text: List my aggregation terms.
      - text: Show every sales aggregation period.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/terms/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an aggregation term
      effect: read
      questions:
      - How do I look up one aggregation period?
      - What are the start and end of a specific term?
      instructions:
      - text: Show term {id}.
        slots:
          id: path.id
      - text: Get the details of aggregation period {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'