Shift4 Payments

Shift4 Payments Subscriptions API

Create and manage recurring subscriptions for customers.

GitHub OpenAPI
Business capability
Subscription Lifecycle Management BC-4240

Operations 3

POST /subscriptions Create a Subscription #
GET /subscriptions/{subscriptionId} Retrieve a Subscription #
POST /subscriptions/{subscriptionId} Update a Subscription #

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

shift4-payments-subscriptions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Shift4 Payments Subscriptions 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: Subscriptions
  description: Create and manage recurring subscriptions for customers.
paths:
  /subscriptions:
    post:
      tags:
      - Subscriptions
      summary: Create a Subscription
      operationId: createSubscription
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionRequest'
      responses:
        '200':
          description: Subscription created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
  /subscriptions/{subscriptionId}:
    parameters:
    - name: subscriptionId
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Subscriptions
      summary: Retrieve a Subscription
      operationId: getSubscription
      responses:
        '200':
          description: A subscription object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
    post:
      tags:
      - Subscriptions
      summary: Update a Subscription
      operationId: updateSubscription
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionRequest'
      responses:
        '200':
          description: Updated subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
components:
  schemas:
    Billing:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
          format: email
        address:
          $ref: '#/components/schemas/Address'
        vatNumber:
          type: string
    Address:
      type: object
      properties:
        line1:
          type: string
        line2:
          type: string
        zip:
          type: string
        city:
          type: string
        state:
          type: string
        country:
          type: string
          description: ISO 3166-1 alpha-2 country code.
    Subscription:
      type: object
      properties:
        id:
          type: string
        created:
          type: integer
          format: int64
        deleted:
          type: boolean
        planId:
          type: string
        customerId:
          type: string
        quantity:
          type: integer
        captureCharges:
          type: boolean
        status:
          type: string
          enum:
          - ACTIVE
          - PAST_DUE
          - CANCELED
          - UNPAID
        remainingBillingCycles:
          type: integer
        start:
          type: integer
          format: int64
        currentPeriodStart:
          type: integer
          format: int64
        currentPeriodEnd:
          type: integer
          format: int64
        canceledAt:
          type: integer
          format: int64
        endedAt:
          type: integer
          format: int64
        trialStart:
          type: integer
          format: int64
        trialEnd:
          type: integer
          format: int64
        cancelAtPeriodEnd:
          type: boolean
        shipping:
          $ref: '#/components/schemas/Shipping'
        billing:
          $ref: '#/components/schemas/Billing'
        merchantAccountId:
          type: string
        metadata:
          type: object
          additionalProperties:
            type: string
    SubscriptionRequest:
      type: object
      properties:
        planId:
          type: string
        customerId:
          type: string
        cardId:
          type: string
        quantity:
          type: integer
          minimum: 1
          default: 1
        captureCharges:
          type: boolean
          default: true
        trialEnd:
          type: integer
          format: int64
        cancelAtPeriodEnd:
          type: boolean
        shipping:
          $ref: '#/components/schemas/Shipping'
        billing:
          $ref: '#/components/schemas/Billing'
        metadata:
          type: object
          additionalProperties:
            type: string
    Shipping:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
          format: email
        phoneNumber:
          type: string
        address:
          $ref: '#/components/schemas/Address'
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: Use your secret API key as the username with an empty password.