Shift4 Payments

Shift4 Payments Plans API

Define recurring billing plans used by subscriptions.

GitHub OpenAPI

Operations 4

POST /plans Create a Plan #
GET /plans List Plans #
GET /plans/{planId} Retrieve a Plan #
POST /plans/{planId} Update a Plan #

Documentation

📖
Documentation
https://dev.shift4.com/docs
📖
APIReference
https://dev.shift4.com/docs/api

Specifications

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

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shift4-payments/main/json-schema/shift4-charge-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shift4-payments/main/json-schema/shift4-customer-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shift4-payments/main/json-schema/shift4-card-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shift4-payments/main/json-schema/shift4-token-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shift4-payments/main/json-schema/shift4-subscription-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shift4-payments/main/json-schema/shift4-plan-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shift4-payments/main/json-schema/shift4-refund-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shift4-payments/main/json-schema/shift4-event-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shift4-payments/main/json-schema/shift4-checkout-session-schema.json

Other Resources

🔗
Sandbox
https://dev.shift4.com/docs
🔗
SDKs
https://github.com/shift4developer/shift4-java
🔗
SDKs
https://github.com/shift4developer/shift4-node
🔗
SDKs
https://github.com/shift4developer/shift4-python
🔗
SDKs
https://github.com/shift4developer/shift4-ruby
🔗
SDKs
https://github.com/shift4developer/shift4-php
🔗
SDKs
https://github.com/shift4developer/shift4-net
🔗
SDKs
https://github.com/shift4developer/shift4-ios
🔗
SDKs
https://github.com/shift4developer/shift4-android
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/shift4-payments/main/rules/shift4-api-rules.yml
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/shift4-payments/main/json-ld/shift4-payments-context.jsonld

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/shift4-payments-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

shift4-payments-plans-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Shift4 Payments Plans API
  description: The Shift4 Payments API enables merchants and platforms to accept and manage payments, including one-time charges, refunds, customers, cards, tokenization, subscriptions, plans, payment methods, payment links, checkout sessions, fraud warnings, blacklist rules, disputes, file uploads, payouts, webhook endpoints, and events.
  version: '1.0'
  contact:
    name: Shift4 Developer Support
    email: devsupport@shift4.com
    url: https://dev.shift4.com
  license:
    name: Documentation
    url: https://dev.shift4.com/docs
servers:
- url: https://api.shift4.com
  description: Production
security:
- BasicAuth: []
tags:
- name: Plans
  description: Define recurring billing plans used by subscriptions.
paths:
  /plans:
    post:
      tags:
      - Plans
      summary: Create a Plan
      operationId: createPlan
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlanRequest'
      responses:
        '200':
          description: Plan created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Plan'
    get:
      tags:
      - Plans
      summary: List Plans
      operationId: listPlans
      parameters:
      - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          description: A list of plans.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanList'
  /plans/{planId}:
    parameters:
    - name: planId
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Plans
      summary: Retrieve a Plan
      operationId: getPlan
      responses:
        '200':
          description: A plan object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Plan'
    post:
      tags:
      - Plans
      summary: Update a Plan
      operationId: updatePlan
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlanRequest'
      responses:
        '200':
          description: Updated plan.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Plan'
components:
  schemas:
    Plan:
      type: object
      properties:
        id:
          type: string
        created:
          type: integer
          format: int64
        deleted:
          type: boolean
        amount:
          type: integer
        currency:
          type: string
        interval:
          type: string
          enum:
          - DAY
          - WEEK
          - MONTH
          - YEAR
        intervalCount:
          type: integer
        billingCycles:
          type: integer
        name:
          type: string
        trialPeriodDays:
          type: integer
        recursTo:
          type: string
        statementDescription:
          type: string
        metadata:
          type: object
          additionalProperties:
            type: string
    ListResponsePlan:
      type: object
      properties:
        list:
          type: array
          items:
            $ref: '#/components/schemas/Plan'
        hasMore:
          type: boolean
        totalCount:
          type: integer
    PlanList:
      $ref: '#/components/schemas/ListResponsePlan'
    PlanRequest:
      type: object
      required:
      - amount
      - currency
      - interval
      - name
      properties:
        amount:
          type: integer
          minimum: 1
        currency:
          type: string
        interval:
          type: string
          enum:
          - day
          - week
          - month
          - year
        intervalCount:
          type: integer
          minimum: 1
          default: 1
        billingCycles:
          type: integer
        name:
          type: string
        trialPeriodDays:
          type: integer
        recursTo:
          type: string
        statementDescription:
          type: string
        metadata:
          type: object
          additionalProperties:
            type: string
  parameters:
    Limit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 10
      description: A limit on the number of objects to be returned.
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: Use your secret API key as the username with an empty password.