Credorax Plans API

openapi: 3.2.0
info:
  title: Credorax Plans API
  version: '2026-10-11'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-11: 9 operation(s) read from 7 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Credorax has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 5
    documentation: 4
    pages-with-code: 7
    pages-read: 7
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-11'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://dev.shift4.com/docs/api
  - https://dev.shift4.com/docs/api/shift4-gateway
  - https://dev.shift4.com/docs/api/shift4-gateway/cards
  - https://dev.shift4.com/docs/api/shift4-gateway/plans
  - https://dev.shift4.com/docs/api/shift4-gateway/events
  - https://dev.shift4.com/docs/api/shift4-gateway/tokens
  - https://dev.shift4.com/docs/api/shift4-gateway/charges
servers:
- url: https://api.shift4.com
security:
- basic: []
tags:
- name: Plans
paths:
  /plans:
    get:
      operationId: get_plans
      tags:
      - Plans
      summary: GET /plans
      x-source: https://dev.shift4.com/docs/api/shift4-gateway/plans
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlansResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl curl https://api.shift4.com/plans  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:  -d "amount=499"  -d "currency=USD"  -d "interval=day"  -d "intervalCount=10"  -d "name=Example plan" Try it Responses 200 400 Plan created Body application/json id string Unique identifier for the plan Example : "plan_bLu3vzO8yhAFhbxFEadm6HUV" created integer Unix timestamp when the plan was created Example : 1711929600 '
    post:
      operationId: post_plans
      tags:
      - Plans
      summary: Create a plan
      x-source: https://dev.shift4.com/docs/api/shift4-gateway/plans
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostPlansRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostPlansResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetPlansResponse:
      type: object
      properties:
        id:
          type: string
        created:
          type: integer
        objectType:
          type: string
        amount:
          type: integer
        currency:
          type: string
        interval:
          type: string
        intervalCount:
          type: integer
        billingCycles:
          type:
          - string
          - 'null'
        name:
          type: string
        trialPeriodDays:
          type: integer
        recursTo:
          type:
          - string
          - 'null'
        metadata:
          type: object
    PostPlansRequest:
      type: object
      properties:
        amount:
          type: integer
          description: Subscription charge amount in minor units of the given currency.
        currency:
          type: string
          description: Subscription charge currency represented as a three-letter ISO currency code.
        interval:
          type: string
          description: Frequency of the subscription charges.
        intervalCount:
          type: integer
          description: Number of intervals between the subscription charges.
        name:
          type: string
          description: Display name of this plan.
        billingCycles:
          type: integer
          description: Number of charges after which the subscription will be automatically canceled.
        trialPeriodDays:
          type: integer
          description: Number of days between the creation of the subscription and the first charge.
        recursTo:
          type: string
          description: When the subscription is automatically canceled, it will move to the plan defined by this attribute.
        splits:
          type: array
          description: Array of objects (ChargeSplitCreate) Allows to transfer part of a charge amount to the given merchant.
        metadata:
          type: object
          description: A set of key-value pairs attached to the plan.
      required:
      - amount
      - currency
      - interval
      - name
    PostPlansResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the plan
        created:
          type: integer
          description: Unix timestamp when the plan was created
        objectType:
          type: string
          description: Object type identifier
        amount:
          type: integer
          description: Subscription charge amount in minor units of the given currency.
        currency:
          type: string
          description: Subscription charge currency represented as a three-letter ISO currency code.
        interval:
          type: string
          description: Frequency of subscription charges.
        intervalCount:
          type: integer
          description: Number of intervals between subscription charges.
        billingCycles:
          type: integer
          description: Number of charges after which the subscription will be automatically canceled.
        name:
          type: string
          description: Display name of this plan
        trialPeriodDays:
          type: integer
          description: Number of days between the creation of the subscription and the first charge.
        recursTo:
          type: string
          description: When the subscription is automatically canceled, it will move to the plan defined by this attribute.
        splits:
          type: array
          description: Information about split requests defined when creating the plan.
        metadata:
          type: object
          description: Set of key-value pairs
  securitySchemes:
    basic:
      type: http
      scheme: basic
      x-source: https://dev.shift4.com/docs/api/shift4-gateway/section/authentication