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-customers-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 email required.

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 3D Secure Customers 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: Customers
paths:
  /customers:
    get:
      operationId: listCustomers
      tags:
      - Customers
      summary: List customers
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          $ref: '#/components/responses/List'
    post:
      operationId: createCustomer
      tags:
      - Customers
      summary: Create a customer
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                email:
                  type: string
                description:
                  type: string
                card:
                  type: string
                  description: Token id to attach as default card
                metadata:
                  type: object
                  additionalProperties: true
      responses:
        '200':
          $ref: '#/components/responses/Customer'
  /customers/{id}:
    parameters:
    - $ref: '#/components/parameters/id'
    get:
      operationId: retrieveCustomer
      tags:
      - Customers
      summary: Retrieve a customer
      responses:
        '200':
          $ref: '#/components/responses/Customer'
    post:
      operationId: updateCustomer
      tags:
      - Customers
      summary: Update a customer
      responses:
        '200':
          $ref: '#/components/responses/Customer'
    delete:
      operationId: deleteCustomer
      tags:
      - Customers
      summary: Delete a customer
      responses:
        '200':
          $ref: '#/components/responses/Deleted'
components:
  schemas:
    Object:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
        livemode:
          type: boolean
        created:
          type: integer
          description: Unix timestamp
      additionalProperties: true
    Customer:
      type: object
      properties:
        id:
          type: string
          example: cus_xxxxxxxxxxxxxxxx
        object:
          type: string
          example: customer
        email:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        default_card:
          type:
          - string
          - 'null'
        cards:
          $ref: '#/components/schemas/List'
        subscriptions:
          $ref: '#/components/schemas/List'
        created:
          type: integer
        livemode:
          type: boolean
    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'
  parameters:
    offset:
      name: offset
      in: query
      schema:
        type: integer
        default: 0
    limit:
      name: limit
      in: query
      schema:
        type: integer
        default: 10
        maximum: 100
    id:
      name: id
      in: path
      required: true
      schema:
        type: string
  responses:
    List:
      description: A paginated list object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/List'
    Customer:
      description: A Customer object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Customer'
    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
  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.