> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flinks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancel Schedule

> Cancel an active recurring payment schedule. This stops all future payments that have not yet been submitted.

<Warning>
  **Work in progress**

  This section is currently under active development as part of improvements planned for 2026. Content may change as we expand product capabilities.

  If you're interested in early access or want to learn more about what's coming, feel free to [reach out to the team](/guides/support/contact-flinks).
</Warning>

Cancel an active recurring payment schedule. This stops all future payments that have not yet been submitted.

## When Cancellation is Allowed

A schedule can be cancelled as long as it has remaining future payments. Payments that have already been submitted to Payments Canada are not affected by the cancellation.

A successful cancellation returns an empty `200 OK` response.


## OpenAPI

````yaml POST /api/v1/schedules/{scheduleId}/cancel
openapi: 3.0.3
info:
  title: Flinks EFT API
  description: >
    Flinks Electronic Funds Transfer (EFT) API provides endpoints to create,
    monitor, and manage PAD-based debit and credit transactions through Canada's
    EFT rail.


    ## Authentication

    Most endpoints require authentication using an API key passed via the
    `x-client-id` header, provided during onboarding.


    For more information, visit: https://docs.flinks.com
  version: 1.0.0
  contact:
    name: Flinks Support
    url: https://www.flinks.com/contact/sales
  termsOfService: https://www.flinks.com
servers:
  - url: https://www.{baseurl}.com
    description: Flinks Pay Production
    variables:
      baseurl:
        default: '{baseurl}'
        description: The base URI for the environment (e.g. flinks)
security: []
tags:
  - name: Transactions
    description: Create EFT debit and credit transactions
  - name: Payment Requests
    description: Monitor and manage payment requests
  - name: Schedules
    description: Manage recurring payment schedules
  - name: Contacts
    description: Retrieve stored contact information
  - name: PAD Agreements
    description: Retrieve Pre-Authorized Debit agreements
  - name: Institutions
    description: Retrieve supported financial institutions
paths:
  /api/v1/schedules/{scheduleId}/cancel:
    post:
      tags:
        - Schedules
      summary: Cancel Schedule
      description: >-
        Cancel an active recurring payment schedule. This stops all future
        payments that have not yet been submitted.
      operationId: cancelEftSchedule
      parameters:
        - name: scheduleId
          in: path
          required: true
          description: The schedule identifier to cancel.
          schema:
            type: string
            format: uuid
          example: a1b2c3d4-5678-90ab-cdef-1234567890ab
        - name: x-client-id
          in: header
          required: true
          description: Your API key provided during onboarding.
          schema:
            type: string
      responses:
        '200':
          description: Schedule cancelled successfully
        '400':
          description: Bad Request - Schedule cannot be cancelled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                type: https://tools.ietf.org/html/rfc7231#section-6.5.1
                title: Bad Request
                status: 400
                detail: Schedule cannot be cancelled.
        '401':
          description: Unauthorized - Invalid or missing x-client-id header
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          description: Error type URI.
          example: https://tools.ietf.org/html/rfc7231#section-6.5.1
        title:
          type: string
          description: Error title.
          example: Bad Request
        status:
          type: integer
          description: HTTP status code.
          example: 400
        detail:
          type: string
          description: Human-readable error description.
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Field-level validation errors.

````