PAY.JP · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for PAY.JP Customers API

6 actions 6 updates phrasing extends openapi/payjp-customers-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 6

$.info

$.paths['/customers'].get

$.paths['/customers'].post

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

$.paths['/customers/{id}'].post

$.paths['/customers/{id}'].delete

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 Customers API
  version: 1.0.0
extends: openapi/payjp-customers-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['/customers'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers
      effect: read
      questions:
      - How do I get a list of all my customers?
      - Can I page through customers with a limit and offset?
      instructions:
      - text: List my customers.
      - text: Show {limit} customers starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer
      effect: write
      questions:
      - How do I create a customer so I can charge them again later?
      - Can I save a card as the default when I create a customer?
      instructions:
      - text: Create a customer with email {email}.
        slots:
          email: requestBody.email
      - text: Create customer {email} with default card token {card}.
        slots:
          email: requestBody.email
          card: requestBody.card
      - text: Add a new customer described as {description}.
        slots:
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer
      effect: read
      questions:
      - How do I look up one customer's details?
      - What information is stored on a particular customer?
      instructions:
      - text: Show customer {id}.
        slots:
          id: path.id
      - text: Get the record for customer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customers/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a customer
      effect: write
      questions:
      - How do I change an existing customer's details?
      - Can I edit a customer after creating them?
      instructions:
      - text: Update customer {id}.
        slots:
          id: path.id
      - text: Edit the details of existing customer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer
      effect: destructive
      questions:
      - How do I permanently remove a customer?
      - What happens to a customer record when I delete it?
      instructions:
      - text: Delete customer {id}.
        slots:
          id: path.id
      - text: Permanently remove customer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'