PAY.JP

PAY.JP Plans API

The Plans API from PAY.JP — 2 operation(s) for plans.

GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /plans List recurring plans · List plans #
Ask an LLM
“What recurring billing plans have I set up?”
“How do I see all my subscription plans?”
Tell an agent
List my plans.
Show every recurring plan on my account.
POST /plans Create a recurring billing plan · Create a recurring plan #
Ask an LLM
“How do I set up a monthly plan for subscriptions?”
“Can a plan include a free trial period?”
Tell an agent
Create a plan named {name} for {amount} {currency} every {interval}.
Create a {amount} {currency} {interval} plan with a {trial_days}-day trial.
GET /plans/{id} Get a plan · Retrieve a plan #
Ask an LLM
“How do I check the price and interval of one plan?”
“What are the settings on a particular plan?”
Tell an agent
Show plan {id}.
Get the details of plan {id}.
POST /plans/{id} Update a plan · Update a plan #
Ask an LLM
“Can I edit a plan after I've created it?”
“How do I change an existing recurring plan?”
Tell an agent
Update plan {id}.
Edit existing plan {id}.
DELETE /plans/{id} Delete a plan · Delete a plan #
Ask an LLM
“How do I remove a plan I no longer offer?”
“What happens when I delete a recurring plan?”
Tell an agent destructive · confirm first
Delete plan {id}.
Remove recurring plan {id}.

Documentation

📖
Documentation
https://pay.jp/docs/charge
📖
APIReference
https://docs.pay.jp/v1/api/
📖
Documentation
https://docs.pay.jp/v1/customer
📖
Documentation
https://docs.pay.jp/v1/subscription
📖
Documentation
https://pay.jp/docs/platform-payment

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/payjp/refs/heads/main/openapi/payjp-plans-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/payjp:payjp-plans-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

payjp-plans-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: PAY.JP Plans API
  description: PAY.JP is an online payment service operated by PAY, Inc. (PAY株式会社) in Japan. The REST API creates charges, tokenizes cards, manages customers, runs subscriptions (定期課金), and reports transfers (入金) and balances in Japanese yen. Authentication is HTTP Basic with a secret key (sk_test_ / sk_live_) as the username and an empty password. All amounts are integer JPY.
  termsOfService: https://pay.jp/terms
  contact:
    name: PAY.JP Support
    url: https://help.pay.jp/
  version: '1.0'
servers:
- url: https://api.pay.jp/v1
  description: PAY.JP REST API (HTTPS only)
security:
- basicAuth: []
tags:
- name: Plans
paths:
  /plans:
    get:
      operationId: listPlans
      tags:
      - Plans
      summary: List plans
      responses:
        '200':
          $ref: '#/components/responses/List'
    post:
      operationId: createPlan
      tags:
      - Plans
      summary: Create a recurring plan
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                amount:
                  type: integer
                currency:
                  type: string
                  enum:
                  - jpy
                  default: jpy
                interval:
                  type: string
                  enum:
                  - month
                  - year
                trial_days:
                  type: integer
                billing_day:
                  type: integer
                name:
                  type: string
              required:
              - amount
              - currency
              - interval
      responses:
        '200':
          $ref: '#/components/responses/Plan'
  /plans/{id}:
    parameters:
    - $ref: '#/components/parameters/id'
    get:
      operationId: retrievePlan
      tags:
      - Plans
      summary: Retrieve a plan
      responses:
        '200':
          $ref: '#/components/responses/Plan'
    post:
      operationId: updatePlan
      tags:
      - Plans
      summary: Update a plan
      responses:
        '200':
          $ref: '#/components/responses/Plan'
    delete:
      operationId: deletePlan
      tags:
      - Plans
      summary: Delete a plan
      responses:
        '200':
          $ref: '#/components/responses/Deleted'
components:
  responses:
    Plan:
      description: A Plan object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Object'
    List:
      description: A paginated list object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/List'
    Deleted:
      description: A deletion confirmation
      content:
        application/json:
          schema:
            type: object
            properties:
              id:
                type: string
              object:
                type: string
                example: charge
              deleted:
                type: boolean
                example: true
  parameters:
    id:
      name: id
      in: path
      required: true
      schema:
        type: string
  schemas:
    Object:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
        livemode:
          type: boolean
        created:
          type: integer
          description: Unix timestamp
      additionalProperties: true
    List:
      type: object
      properties:
        object:
          type: string
          example: list
        count:
          type: integer
        has_more:
          type: boolean
        url:
          type: string
        data:
          type: array
          items:
            $ref: '#/components/schemas/Object'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication. Use the secret key (sk_test_ / sk_live_) as the username and leave the password empty.