Shift4 Payments API — Subscriptions

naftiko: 1.0.0-alpha2
info:
  label: Shift4 Payments API — Subscriptions
  description: 'Shift4 Payments API — Subscriptions. 3 operations. Lead operation: Create a Subscription. Self-contained Naftiko
    capability covering one Shift4 Payments business surface.'
  tags:
  - Shift4 Payments
  - Subscriptions
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHIFT4_PAYMENTS_API_KEY: SHIFT4_PAYMENTS_API_KEY
capability:
  consumes:
  - type: http
    namespace: shift4-subscriptions
    baseUri: https://api.shift4.com
    description: Shift4 Payments API — Subscriptions business capability. Self-contained, no shared references.
    resources:
    - name: subscriptions
      path: /subscriptions
      operations:
      - name: createsubscription
        method: POST
        description: Create a Subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: subscriptions-subscriptionId
      path: /subscriptions/{subscriptionId}
      operations:
      - name: getsubscription
        method: GET
        description: Retrieve a Subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatesubscription
        method: POST
        description: Update a Subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: basic
      username: '{{env.SHIFT4_PAYMENTS_USER}}'
      password: '{{env.SHIFT4_PAYMENTS_PASS}}'
  exposes:
  - type: rest
    namespace: shift4-subscriptions-rest
    port: 8080
    description: REST adapter for Shift4 Payments API — Subscriptions. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/subscriptions
      name: subscriptions
      description: REST surface for subscriptions.
      operations:
      - method: POST
        name: createsubscription
        description: Create a Subscription
        call: shift4-subscriptions.createsubscription
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/subscriptions/{subscriptionid}
      name: subscriptions-subscriptionid
      description: REST surface for subscriptions-subscriptionId.
      operations:
      - method: GET
        name: getsubscription
        description: Retrieve a Subscription
        call: shift4-subscriptions.getsubscription
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: updatesubscription
        description: Update a Subscription
        call: shift4-subscriptions.updatesubscription
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shift4-subscriptions-mcp
    port: 9090
    transport: http
    description: MCP adapter for Shift4 Payments API — Subscriptions. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: create-subscription
      description: Create a Subscription
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shift4-subscriptions.createsubscription
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-subscription
      description: Retrieve a Subscription
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shift4-subscriptions.getsubscription
      outputParameters:
      - type: object
        mapping: $.
    - name: update-subscription
      description: Update a Subscription
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shift4-subscriptions.updatesubscription
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.