PAY.JP

PAY.JP Subscriptions API

The Subscriptions API from PAY.JP — 5 operation(s) for subscriptions.

Documentation GitHub OpenAPI

Business capability

Subscription Lifecycle Management BC-4240

Operations 8

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 /subscriptions List subscriptions · List subscriptions #

Ask an LLM

“How do I see all my active and past subscriptions?”

“Which customers are subscribed to plans?”

Tell an agent

List my subscriptions.

Show every subscription on my account.

POST /subscriptions Subscribe a customer to a plan · Create a subscription (定期課金) #

Ask an LLM

“How do I put a customer on a recurring plan?”

“Can I prorate the first charge when a subscription starts mid-cycle?”

Tell an agent

Subscribe customer {customer} to plan {plan}.

Start plan {plan} for customer {customer} with proration {prorate}.

GET /subscriptions/{id} Get a subscription · Retrieve a subscription #

Ask an LLM

“How do I check the status of one subscription?”

“Is a particular subscription active, paused or canceled?”

Tell an agent

Show subscription {id}.

Get the current status of subscription {id}.

POST /subscriptions/{id} Update a subscription · Update a subscription #

Ask an LLM

“How do I change the settings on an existing subscription?”

“Can I modify a subscription without canceling it?”

Tell an agent

Update subscription {id}.

Change the settings of existing subscription {id}.

DELETE /subscriptions/{id} Delete a subscription · Delete a subscription #

Ask an LLM

“How do I delete a subscription record entirely?”

“Can I remove a subscription outright rather than just canceling it?”

Tell an agent destructive · confirm first

Delete subscription {id}.

Permanently remove subscription {id}.

POST /subscriptions/{id}/pause Pause a subscription · Pause a subscription #

Ask an LLM

“Can I temporarily stop billing a subscriber?”

“How do I put a subscription on hold?”

Tell an agent

Pause subscription {id}.

Put subscription {id} on hold so it stops billing.

POST /subscriptions/{id}/resume Resume a paused subscription · Resume a paused subscription #

Ask an LLM

“How do I restart billing on a paused subscription?”

“Can a paused subscription be reactivated?”

Tell an agent

Resume paused subscription {id}.

Reactivate subscription {id} after its pause.

POST /subscriptions/{id}/cancel Cancel a subscription · Cancel a subscription #

Ask an LLM

“How do I cancel a customer's subscription?”

“What call stops a subscription from renewing?”

Tell an agent destructive · confirm first

Cancel subscription {id}.

Stop subscription {id} from renewing.

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-subscriptions-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-subscriptions-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

openapi: 3.2.0
info:
  title: PAY.JP Subscriptions 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: Subscriptions
paths:
  /subscriptions:
    get:
      operationId: listSubscriptions
      tags:
      - Subscriptions
      summary: List subscriptions
      responses:
        '200':
          $ref: '#/components/responses/List'
    post:
      operationId: createSubscription
      tags:
      - Subscriptions
      summary: Create a subscription (定期課金)
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                customer:
                  type: string
                plan:
                  type: string
                prorate:
                  type: boolean
                metadata:
                  type: object
                  additionalProperties: true
              required:
              - customer
              - plan
      responses:
        '200':
          $ref: '#/components/responses/Subscription'
  /subscriptions/{id}:
    parameters:
    - $ref: '#/components/parameters/id'
    get:
      operationId: retrieveSubscription
      tags:
      - Subscriptions
      summary: Retrieve a subscription
      responses:
        '200':
          $ref: '#/components/responses/Subscription'
    post:
      operationId: updateSubscription
      tags:
      - Subscriptions
      summary: Update a subscription
      responses:
        '200':
          $ref: '#/components/responses/Subscription'
    delete:
      operationId: deleteSubscription
      tags:
      - Subscriptions
      summary: Delete a subscription
      responses:
        '200':
          $ref: '#/components/responses/Deleted'
  /subscriptions/{id}/pause:
    parameters:
    - $ref: '#/components/parameters/id'
    post:
      operationId: pauseSubscription
      tags:
      - Subscriptions
      summary: Pause a subscription
      responses:
        '200':
          $ref: '#/components/responses/Subscription'
  /subscriptions/{id}/resume:
    parameters:
    - $ref: '#/components/parameters/id'
    post:
      operationId: resumeSubscription
      tags:
      - Subscriptions
      summary: Resume a paused subscription
      responses:
        '200':
          $ref: '#/components/responses/Subscription'
  /subscriptions/{id}/cancel:
    parameters:
    - $ref: '#/components/parameters/id'
    post:
      operationId: cancelSubscription
      tags:
      - Subscriptions
      summary: Cancel a subscription
      responses:
        '200':
          $ref: '#/components/responses/Subscription'
components:
  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'
  responses:
    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
    Subscription:
      description: A Subscription object
      content:
        application/json:
          schema:
            $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.