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.
# 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 Plans API
version: 1.0.0
extends: openapi/payjp-plans-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['/plans'].get
update:
x-apievangelist-phrasing:
intent: List recurring plans
effect: read
questions:
- What recurring billing plans have I set up?
- How do I see all my subscription plans?
instructions:
- text: List my plans.
- text: Show every recurring plan on my account.
method: generated
generated: '2026-09-26'
- target: $.paths['/plans'].post
update:
x-apievangelist-phrasing:
intent: Create a recurring billing plan
effect: write
questions:
- How do I set up a monthly plan for subscriptions?
- Can a plan include a free trial period?
- Is it possible to bill on a fixed day of the month?
instructions:
- text: Create a plan named {name} for {amount} {currency} every {interval}.
slots:
name: requestBody.name
amount: requestBody.amount
currency: requestBody.currency
interval: requestBody.interval
- text: Create a {amount} {currency} {interval} plan with a {trial_days}-day trial.
slots:
amount: requestBody.amount
currency: requestBody.currency
interval: requestBody.interval
trial_days: requestBody.trial_days
- text: Create a {amount} {currency} {interval} plan billed on day {billing_day}.
slots:
amount: requestBody.amount
currency: requestBody.currency
interval: requestBody.interval
billing_day: requestBody.billing_day
method: generated
generated: '2026-09-26'
- target: $.paths['/plans/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a plan
effect: read
questions:
- How do I check the price and interval of one plan?
- What are the settings on a particular plan?
instructions:
- text: Show plan {id}.
slots:
id: path.id
- text: Get the details of plan {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/plans/{id}'].post
update:
x-apievangelist-phrasing:
intent: Update a plan
effect: write
questions:
- Can I edit a plan after I've created it?
- How do I change an existing recurring plan?
instructions:
- text: Update plan {id}.
slots:
id: path.id
- text: Edit existing plan {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/plans/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a plan
effect: destructive
questions:
- How do I remove a plan I no longer offer?
- What happens when I delete a recurring plan?
instructions:
- text: Delete plan {id}.
slots:
id: path.id
- text: Remove recurring plan {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.