vCita Scheduled Payment Rule API

The Scheduled Payment Rule API from vCita — 3 operation(s) for scheduled payment rule.

GitHub OpenAPI

Operations 5

GET /business/payments/v1/scheduled_payments_rules Get list of Scheduled Payment Rules #
POST /business/payments/v1/scheduled_payments_rules Create Scheduled Payment Rule #
GET /business/payments/v1/scheduled_payments_rules/{uid} Get Scheduled Payment Rule #
PUT /business/payments/v1/scheduled_payments_rules/{uid} Update Scheduled Payment Rule #
PUT /business/payments/v1/scheduled_payments_rules/{uid}/cancel Cancel Recurring Payments Rule #

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/vcita:vcita-scheduled-payment-rule-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

vcita-scheduled-payment-rule-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Sales Scheduled Payment Rule API
  description: Unified OpenAPI specification for sales domain
  version: '3.0'
  x-generated:
    sourceFiles:
    - legacy_v1_sales.json
    - sales_reports.json
    - payment_plans.json
    - payments.json
    - payment_gateway.json
    - legacy_v2_settings_services.json
    - legacy_v2_settings_categories.json
    - client_cards.json
    - client_payment_cards.json
    - creditNote.json
    - estimates.json
    - coupons.json
    - invoice.json
    - coupon.json
    pathNormalizations:
    - file: legacy_v1_sales.json
      basePath: /platform/v1
      transformations:
      - original: /leadgen
        normalized: /platform/v1/leadgen
        basePath: /platform/v1
      - original: /payments
        normalized: /platform/v1/payments
        basePath: /platform/v1
      - original: /payments/{payment_uid}
        normalized: /platform/v1/payments/{payment_uid}
        basePath: /platform/v1
      - original: /payments/{payment_uid}/match
        normalized: /platform/v1/payments/{payment_uid}/match
        basePath: /platform/v1
      - original: /invoices
        normalized: /platform/v1/invoices
        basePath: /platform/v1
      - original: /invoices/{invoice_id}
        normalized: /platform/v1/invoices/{invoice_id}
        basePath: /platform/v1
      - original: /payment/cards/sync_card
        normalized: /platform/v1/payment/cards/sync_card
        basePath: /platform/v1
      - original: /payment/cards/{card_id}
        normalized: /platform/v1/payment/cards/{card_id}
        basePath: /platform/v1
      - original: /payment/checkout/
        normalized: /platform/v1/payment/checkout/
        basePath: /platform/v1
      - original: /payment/checkout/{url_key}
        normalized: /platform/v1/payment/checkout/{url_key}
        basePath: /platform/v1
      - original: /payment/client_packages
        normalized: /platform/v1/payment/client_packages
        basePath: /platform/v1
      - original: /payment/client_packages/cancel_redemption
        normalized: /platform/v1/payment/client_packages/cancel_redemption
        basePath: /platform/v1
      - original: /payment/client_packages/update_usage
        normalized: /platform/v1/payment/client_packages/update_usage
        basePath: /platform/v1
      - original: /payment/packages
        normalized: /platform/v1/payment/packages
        basePath: /platform/v1
      - original: /payment/packages/{package_id}
        normalized: /platform/v1/payment/packages/{package_id}
        basePath: /platform/v1
      - original: /payment/settings
        normalized: /platform/v1/payment/settings
        basePath: /platform/v1
      - original: /payment/settings/update_default_currency
        normalized: /platform/v1/payment/settings/update_default_currency
        basePath: /platform/v1
      - original: /payment_statuses/{id}/apply_coupon
        normalized: /platform/v1/payment_statuses/{id}/apply_coupon
        basePath: /platform/v1
      - original: /payment_statuses/{id}/validate_coupon
        normalized: /platform/v1/payment_statuses/{id}/validate_coupon
        basePath: /platform/v1
      - original: /services
        normalized: /platform/v1/services
        basePath: /platform/v1
      - original: /services/availability
        normalized: /platform/v1/services/availability
        basePath: /platform/v1
      - original: /services/{service_uid}
        normalized: /platform/v1/services/{service_uid}
        basePath: /platform/v1
      - original: /services/{service_uid}/availability
        normalized: /platform/v1/services/{service_uid}/availability
        basePath: /platform/v1
    - file: payments.json
      basePath: /business/payments
      transformations:
      - original: /v1/card_requests
        normalized: /business/payments/v1/card_requests
        basePath: /business/payments
      - original: /v1/card_requests/{client_uid}
        normalized: /business/payments/v1/card_requests/{client_uid}
        basePath: /business/payments
      - original: /v1/cards/{uid}
        normalized: /business/payments/v1/cards/{uid}
        basePath: /business/payments
      - original: /v1/carts
        normalized: /business/payments/v1/carts
        basePath: /business/payments
      - original: /v1/carts/{uid}
        normalized: /business/payments/v1/carts/{uid}
        basePath: /business/payments
      - original: /v1/carts/{uid}/cancel
        normalized: /business/payments/v1/carts/{uid}/cancel
        basePath: /business/payments
      - original: /v1/carts/{uid}/cart_completed
        normalized: /business/payments/v1/carts/{uid}/cart_completed
        basePath: /business/payments
      - original: /v1/client_packages/{uid}
        normalized: /business/payments/v1/client_packages/{uid}
        basePath: /business/payments
      - original: /v1/deposits
        normalized: /business/payments/v1/deposits
        basePath: /business/payments
      - original: /v1/deposits/{uid}
        normalized: /business/payments/v1/deposits/{uid}
        basePath: /business/payments
      - original: /v1/estimates
        normalized: /business/payments/v1/estimates
        basePath: /business/payments
      - original: /v1/estimates/{estimate_uid}
        normalized: /business/payments/v1/estimates/{estimate_uid}
        basePath: /business/payments
      - original: /v1/invoices
        normalized: /business/payments/v1/invoices
        basePath: /business/payments
      - original: /v1/invoices/{invoice_uid}
        normalized: /business/payments/v1/invoices/{invoice_uid}
        basePath: /business/payments
      - original: /v1/invoices/{invoice_uid}/cancel
        normalized: /business/payments/v1/invoices/{invoice_uid}/cancel
        basePath: /business/payments
      - original: /v1/packages/reorder
        normalized: /business/payments/v1/packages/reorder
        basePath: /business/payments
      - original: /v1/payment_requests
        normalized: /business/payments/v1/payment_requests
        basePath: /business/payments
      - original: /v1/payment_requests/{payment_request_uid}/send_link
        normalized: /business/payments/v1/payment_requests/{payment_request_uid}/send_link
        basePath: /business/payments
      - original: /v1/payment_requests/{payment_request_uid}
        normalized: /business/payments/v1/payment_requests/{payment_request_uid}
        basePath: /business/payments
      - original: /v1/payments
        normalized: /business/payments/v1/payments
        basePath: /business/payments
      - original: /v1/payments/{payment_uid}
        normalized: /business/payments/v1/payments/{payment_uid}
        basePath: /business/payments
      - original: /v1/payouts
        normalized: /business/payments/v1/payouts
        basePath: /business/payments
      - original: /v1/payouts/{provider_payout_id}
        normalized: /business/payments/v1/payouts/{provider_payout_id}
        basePath: /business/payments
      - original: /v1/product_orders
        normalized: /business/payments/v1/product_orders
        basePath: /business/payments
      - original: /v1/product_orders/{product_order_uid}
        normalized: /business/payments/v1/product_orders/{product_order_uid}
        basePath: /business/payments
      - original: /v1/products
        normalized: /business/payments/v1/products
        basePath: /business/payments
      - original: /v1/products/{product_uid}
        normalized: /business/payments/v1/products/{product_uid}
        basePath: /business/payments
      - original: /v1/refunds
        normalized: /business/payments/v1/refunds
        basePath: /business/payments
      - original: /v1/scheduled_payments_rules
        normalized: /business/payments/v1/scheduled_payments_rules
        basePath: /business/payments
      - original: /v1/scheduled_payments_rules/{uid}/cancel
        normalized: /business/payments/v1/scheduled_payments_rules/{uid}/cancel
        basePath: /business/payments
      - original: /v1/scheduled_payments_rules/{uid}
        normalized: /business/payments/v1/scheduled_payments_rules/{uid}
        basePath: /business/payments
      - original: /v1/tax_bulk
        normalized: /business/payments/v1/tax_bulk
        basePath: /business/payments
      - original: /v1/tax_bulk/apply_defaults
        normalized: /business/payments/v1/tax_bulk/apply_defaults
        basePath: /business/payments
      - original: /v1/taxes
        normalized: /business/payments/v1/taxes
        basePath: /business/payments
      - original: /v1/taxes/{tax_uid}
        normalized: /business/payments/v1/taxes/{tax_uid}
        basePath: /business/payments
      - original: /v1/transactions
        normalized: /business/payments/v1/transactions
        basePath: /business/payments
      - original: /v1/transactions/{provider_transaction_id}
        normalized: /business/payments/v1/transactions/{provider_transaction_id}
        basePath: /business/payments
    - file: estimates.json
      basePath: /platform/v1
      transformations:
      - original: /estimates
        normalized: /platform/v1/estimates
        basePath: /platform/v1
    pathConflicts: []
    componentConflicts:
    - type: schema
      name: ErrorResponse
      resolution: Renamed to ErrorResponse_payment_plans
      files:
      - merged
      - payment_plans.json
    - type: schema
      name: ErrorResponse
      resolution: Renamed to ErrorResponse_client_cards
      files:
      - merged
      - client_cards.json
    totalPaths: 87
    totalComponents: 13
servers:
- url: https://api.vcita.biz
  description: Unified API Gateway server
tags:
- name: Scheduled Payment Rule
paths:
  /business/payments/v1/scheduled_payments_rules:
    get:
      description: '## Overview

        Get a list of Scheduled Payment Rules. Available for **Staff Tokens**.


        ## Prerequisites

        Scheduled payments require:

        1. Payment gateway configured that supports recurring payments (Stripe, vcitaPayments, Square)

        2. The `scheduled_payments` feature enabled for the business'
      parameters:
      - description: 'Page offset (default: 1)'
        in: query
        name: page
        required: false
        schema:
          type: string
      - description: 'Page size (default: 25)'
        in: query
        name: per_page
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  scheduled_payments_rules:
                  - amount: '50.0'
                    amount_paid: '0.0'
                    canceled_by: ''
                    canceled_date: null
                    created_at: '2025-08-05T06:54:49Z'
                    currency: USD
                    cycles: 20
                    cycles_count: 0
                    description: schedule payment rule example
                    end_date: '2025-12-17T07:56:00Z'
                    frequency_type: weekly
                    matter_uid: js7c2h9g3zwbigf8
                    name: schedule payment rule
                    next_payment_time: '2025-08-06T06:56:00Z'
                    payment_method:
                      type: card
                      uid: tkej8m7xm6ixx6zt
                    rrule: "---\n:start_time: &1\n  :time: 2025-08-06 06:56:00.000000000 Z\n  :zone: Central Time (US & Canada)\n:start_date: *1\n:rrules:\n- :validations: {}\n  :rule_type: IceCube::WeeklyRule\n  :interval: 1\n  :week_start: 0\n  :count: 20\n:rtimes: []\n:extimes: []\n"
                    staff_uid: 1c3ab579d2d31fbb
                    start_date: '2025-08-06T06:56:00Z'
                    status: active
                    uid: skt1h1awrkiv6he1
                    updated_at: '2025-08-05T06:54:49Z'
                success: true
        '422':
          description: Failure
          content:
            application/json:
              example:
                errors:
                - code: Error Code
                  field: Error Field (optional)
                  message: Error Message
                success: false
      summary: Get list of Scheduled Payment Rules
      tags:
      - Scheduled Payment Rule
      x-amazon-apigateway-auth:
        type: NONE
      x-amazon-apigateway-integration:
        httpMethod: GET
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https:///business/payments/v1/scheduled_payments_rules
      x-auth-type: Application & Application User
      security:
      - Bearer: []
      operationId: getBusinessPaymentsV1ScheduledPaymentsRules
      x-operation-id-source: derived
    post:
      description: '## Overview

        Creates a Scheduled Payment Rule Available for **Staff, App, and Directory tokens**.


        ## Prerequisites

        1. Business must have the `scheduled_payments` feature enabled.

        2. Business must have a payment gateway configured that supports recurring payments. Supported gateways: Stripe, vcitaPayments, Square. PayPal is not supported.

        3. The card specified in `payment_method.uid` must be active, belong to the matter client, and use the same payment provider as the business payment gateway.'
      parameters: []
      responses:
        '201':
          description: Success
          content:
            application/json:
              example:
                data:
                  scheduled_payments_rule:
                    amount: '50.0'
                    amount_paid: '0.0'
                    canceled_by: ''
                    canceled_date: null
                    created_at: '2025-08-05T06:54:50Z'
                    currency: USD
                    cycles: 20
                    cycles_count: 0
                    description: schedule payment rule example
                    end_date: '2025-12-17T07:56:00Z'
                    frequency_type: weekly
                    matter_uid: js7c2h9g3zwbigf8
                    name: schedule payment rule
                    next_payment_time: '2025-08-06T06:56:00Z'
                    payment_method:
                      type: card
                      uid: tkej8m7xm6ixx6zt
                    rrule: "---\n:start_time: &1\n  :time: 2025-08-06 06:56:00.000000000 Z\n  :zone: Central Time (US & Canada)\n:start_date: *1\n:rrules:\n- :validations: {}\n  :rule_type: IceCube::WeeklyRule\n  :interval: 1\n  :week_start: 0\n  :count: 20\n:rtimes: []\n:extimes: []\n"
                    staff_uid: 1c3ab579d2d31fbb
                    start_date: '2025-08-06T06:56:00Z'
                    status: active
                    uid: 7gilictbt12jir3v
                    updated_at: '2025-08-05T06:54:50Z'
                success: true
        '422':
          description: Failure
          content:
            application/json:
              example:
                errors:
                - code: Error Code
                  field: Error Field (optional)
                  message: Error Message
                success: false
      summary: Create Scheduled Payment Rule
      tags:
      - Scheduled Payment Rule
      x-amazon-apigateway-auth:
        type: NONE
      x-amazon-apigateway-integration:
        httpMethod: POST
        responses:
          default:
            statusCode: '201'
        type: http_proxy
        uri: https:///business/payments/v1/scheduled_payments_rules
      x-auth-type: Application & Application User
      requestBody:
        content:
          application/json:
            schema:
              properties:
                scheduled_payments_rule:
                  properties:
                    amount:
                      description: Scheduled Payment amount
                      type: number
                    currency:
                      description: Three-letter ISO currency code
                      type: string
                    cycles:
                      description: Scheduled Payment Rule cycles
                      type: integer
                    description:
                      description: Scheduled Payment Rule description
                      type: string
                    frequency_type:
                      description: Scheduled Payment Rule frequency type. Determines how often the scheduled payment recurs. Use "one_time" for a single payment, or "weekly", "bi_weekly", "monthly" for recurring payments.
                      type: string
                      enum:
                      - one_time
                      - weekly
                      - bi_weekly
                      - monthly
                    matter_uid:
                      description: Related Matter UID
                      type: string
                      x-reference-to: clients.matter
                    name:
                      description: Scheduled Payment Rule name
                      type: string
                    payment_method:
                      description: Payment method to use for the scheduled payment. Must reference an existing card saved for the client.
                      properties:
                        type:
                          description: 'Scheduled Payment Rule payment method type. Possible values: card'
                          type: string
                          enum:
                          - card
                        uid:
                          description: Required. Must be a valid card UID from an existing card saved for the client. Use GET /platform/v1/clients/{client_id}/payment/cards to get available card UIDs.
                          type: string
                      required:
                      - type
                      - uid
                      type: object
                    send_receipt:
                      description: Indicates whether to send a receipt to the client
                      type: boolean
                    start_date:
                      description: Scheduled Payment start date in ISO 8601 format
                      type: string
                      format: date-time
                  required:
                  - name
                  - amount
                  - currency
                  - start_date
                  - frequency_type
                  - cycles
                  - send_receipt
                  - matter_uid
                  - payment_method
                  type: object
              required:
              - scheduled_payments_rule
              type: object
      security:
      - Bearer: []
      operationId: postBusinessPaymentsV1ScheduledPaymentsRules
      x-operation-id-source: derived
  /business/payments/v1/scheduled_payments_rules/{uid}:
    get:
      description: '## Overview

        Gets a Scheduled Payment Rule. Available for **Staff Tokens**.


        ## Prerequisites

        Scheduled payments require complex pre-configuration:

        1. **Payment Gateway**: Business must have a payment gateway configured that supports recurring payments (Stripe, vcitaPayments, Square). PayPal is not supported.

        2. **Payment Cards on File**: Clients must have active payment cards saved on file.

        3. **Feature Enabled**: The `scheduled_payments` feature must be enabled for the business.'
      parameters:
      - description: Scheduled Payment Rule UID
        in: path
        name: uid
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  scheduled_payments_rule:
                    amount: '50.0'
                    amount_paid: '0.0'
                    canceled_by: ''
                    canceled_date: null
                    created_at: '2025-08-05T06:54:49Z'
                    currency: USD
                    cycles: 20
                    cycles_count: 0
                    description: schedule payment rule example
                    end_date: '2025-12-17T07:56:00Z'
                    frequency_type: weekly
                    matter_uid: js7c2h9g3zwbigf8
                    name: schedule payment rule
                    next_payment_time: '2025-08-06T06:56:00Z'
                    payment_method:
                      type: card
                      uid: tkej8m7xm6ixx6zt
                    rrule: "---\n:start_time: &1\n  :time: 2025-08-06 06:56:00.000000000 Z\n  :zone: Central Time (US & Canada)\n:start_date: *1\n:rrules:\n- :validations: {}\n  :rule_type: IceCube::WeeklyRule\n  :interval: 1\n  :week_start: 0\n  :count: 20\n:rtimes: []\n:extimes: []\n"
                    staff_uid: 1c3ab579d2d31fbb
                    start_date: '2025-08-06T06:56:00Z'
                    status: active
                    uid: skt1h1awrkiv6he1
                    updated_at: '2025-08-05T06:54:49Z'
                success: true
        '422':
          description: Failure
          content:
            application/json:
              example:
                errors:
                - code: Error Code
                  field: Error Field (optional)
                  message: Error Message
                success: false
      summary: Get Scheduled Payment Rule
      tags:
      - Scheduled Payment Rule
      x-amazon-apigateway-auth:
        type: NONE
      x-amazon-apigateway-integration:
        httpMethod: GET
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https:///business/payments/v1/scheduled_payments_rules/{uid}
      x-auth-type: Application & Application User
      security:
      - Bearer: []
      operationId: getBusinessPaymentsV1ScheduledPaymentsRulesByUid
      x-operation-id-source: derived
    put:
      description: '## Overview

        Updates a Scheduled Payment Rule Available for **Staff, App, and Directory tokens**.


        ## Prerequisites

        1. **Payment Gateway**: Business must have a payment gateway configured that supports recurring payments (Stripe, vcitaPayments, Square). PayPal is NOT supported for scheduled payments.

        2. **Valid Payment Card**: A valid payment card must exist and be associated with the client. Use `GET /platform/v1/clients/{client_id}/payment/cards` to retrieve available card UIDs.

        3. **Existing Rule**: The scheduled payment rule must already exist (created via POST endpoint).


        ## Date Format

        The `start_date` field must be in ISO date format (YYYY-MM-DD) and must be in the future relative to UTC timezone.'
      parameters:
      - description: Scheduled Payment Rule UID
        in: path
        name: uid
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  scheduled_payments_rule:
                    amount: '50.0'
                    amount_paid: '0.0'
                    canceled_by: ''
                    canceled_date: null
                    created_at: '2025-08-05T06:54:49Z'
                    currency: USD
                    cycles: 20
                    cycles_count: 0
                    description: schedule payment rule example
                    end_date: '2025-12-17T07:56:00Z'
                    frequency_type: weekly
                    matter_uid: js7c2h9g3zwbigf8
                    name: schedule payment rule
                    next_payment_time: '2025-08-06T06:56:00Z'
                    payment_method:
                      type: card
                      uid: tkej8m7xm6ixx6zt
                    rrule: "---\n:start_time: &1\n  :time: 2025-08-06 06:56:00.000000000 Z\n  :zone: Central Time (US & Canada)\n:start_date: *1\n:rrules:\n- :validations: {}\n  :rule_type: IceCube::WeeklyRule\n  :interval: 1\n  :week_start: 0\n  :count: 20\n:rtimes: []\n:extimes: []\n"
                    staff_uid: 1c3ab579d2d31fbb
                    start_date: '2025-08-06T06:56:00Z'
                    status: active
                    uid: skt1h1awrkiv6he1
                    updated_at: '2025-08-05T06:54:49Z'
                success: true
        '422':
          description: Failure
          content:
            application/json:
              example:
                errors:
                - code: Error Code
                  field: Error Field (optional)
                  message: Error Message
                success: false
      summary: Update Scheduled Payment Rule
      tags:
      - Scheduled Payment Rule
      x-amazon-apigateway-auth:
        type: NONE
      x-amazon-apigateway-integration:
        httpMethod: PUT
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https:///business/payments/v1/scheduled_payments_rules/{uid}
      x-auth-type: Application & Application User
      requestBody:
        content:
          application/json:
            schema:
              properties:
                scheduled_payments_rule:
                  properties:
                    payment_method:
                      description: Payment method to use for the scheduled payment. Must reference an existing card saved for the client.
                      properties:
                        type:
                          description: 'Scheduled Payment Rule payment method type. Possible values: card'
                          type: string
                          enum:
                          - card
                        uid:
                          description: Required. Must be a valid card UID from an existing card saved for the client. Use GET /platform/v1/clients/{client_id}/payment/cards to get available card UIDs.
                          type: string
                      required:
                      - type
                      - uid
                      type: object
                  required:
                  - payment_method
                  type: object
              required:
              - scheduled_payments_rule
              type: object
      security:
      - Bearer: []
      operationId: putBusinessPaymentsV1ScheduledPaymentsRulesByUid
      x-operation-id-source: derived
  /business/payments/v1/scheduled_payments_rules/{uid}/cancel:
    put:
      description: '## Overview

        Cancels a Recurring Payments Rule Available for **Staff, App, and Directory tokens**.


        ## Prerequisites

        Requires business to have a payment gateway that supports recurring payments. The scheduled payment rule must exist and be in a cancellable state.'
      parameters:
      - description: Recurring Payments Rule UID
        in: path
        name: uid
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  scheduled_payments_rule:
                    amount: '50.0'
                    amount_paid: '0.0'
                    canceled_by: Josephine Harvey
                    canceled_date: '2025-08-05T06:54:50Z'
                    created_at: '2025-08-05T06:54:49Z'
                    currency: USD
                    cycles: 20
                    cycles_count: 0
                    description: schedule payment rule example
                    end_date: '2025-12-17T07:56:00Z'
                    frequency_type: weekly
                    matter_uid: js7c2h9g3zwbigf8
                    name: schedule payment rule
                    next_payment_time: null
                    payment_method:
                      type: card
                      uid: tkej8m7xm6ixx6zt
                    rrule: "---\n:start_time: &1\n  :time: 2025-08-06 06:56:00.000000000 Z\n  :zone: Central Time (US & Canada)\n:start_date: *1\n:rrules:\n- :validations: {}\n  :rule_type: IceCube::WeeklyRule\n  :interval: 1\n  :week_start: 0\n  :count: 20\n:rtimes: []\n:extimes: []\n"
                    staff_uid: 1c3ab579d2d31fbb
                    start_date: '2025-08-06T06:56:00Z'
                    status: cancelled
                    uid: skt1h1awrkiv6he1
                    updated_at: '2025-08-05T06:54:50Z'
                success: true
        '422':
          description: Failure
          content:
            application/json:
              example:
                errors:
                - code: Error Code
                  field: Error Field (optional)
                  message: Error Message
                success: false
      summary: Cancel Recurring Payments Rule
      tags:
      - Scheduled Payment Rule
      x-amazon-apigateway-auth:
        type: NONE
      x-amazon-apigateway-integration:
        httpMethod: PUT
        responses:
          default:
            statusCode: '200'
        type: http_proxy
        uri: https:///business/payments/v1/scheduled_payments_rules/{uid}/cancel
      x-auth-type: Application & Application User
      security:
      - Bearer: []
      operationId: putBusinessPaymentsV1ScheduledPaymentsRulesByUidCancel
      x-operation-id-source: derived
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {app_token}'''
    ClientPaymentCards:
      type: http
      scheme: bearer
      description: Provide a valid bearer token in the Authorization header.
    PaymentPlans:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {token}'''
x-provenance:
  method: searched
  source: https://developers.intandem.tech:443/reference
  harvested: '2026-11-15'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developers.intandem.tech/reference/createpaymentplan.md
  - https://developers.intandem.tech/reference/delete_business-payments-v1-deposits-uid.md
  - https://developers.intandem.tech/reference/delete_business-payments-v1-products-product-uid.md
  - https://developers.intandem.tech/reference/delete_business-payments-v1-tax-bulk.md
  - https://developers.intandem.tech/reference/delete_business-payments-v1-taxes-tax-uid.md
  - https://developers.intandem.tech/reference/delete_platform-v1-payment-cards-card-id.md
  - https://developers.intandem.tech/reference/delete_v2-coupons-uid.md
  - https://developers.intandem.tech/reference/delete_v3-payment-processing-payment-gateways-uid.md
  - https://developers.intandem.tech/reference/get_business-payments-v1-card-requests-client-uid.md
  - https://developers.intandem.tech/reference/get_business-payments-v1-carts-uid.md
  - https://developers.intandem.tech/reference/get_business-payments-v1-client-packages-uid.md
  - https://developers.intandem.tech/reference/get_business-payments-v1-deposits-uid.md
  - https://developers.intandem.tech/reference/get_business-payments-v1-deposits.md
  - https://developers.intandem.tech/reference/get_business-payments-v1-estimates-estimate-uid.md
  - https://developers.intandem.tech/reference/get_business-payments-v1-invoices-invoice-uid.md
  - https://developers.intandem.tech/reference/get_business-payments-v1-payment-requests-payment-request-uid.md
  - https://developers.intandem.tech/reference/get_business-payments-v1-payment-requests.md
  - https://developers.intandem.tech/reference/get_business-payments-v1-payments-payment-uid.md
  - https://developers.intandem.tech/reference/get_business-payments-v1-payments.md
  - https://developers.intandem.tech/reference/get_business-payments-v1-payouts-provider-payout-id.md
  - https://developers.intandem.tech/reference/get_business-payments-v1-product-orders-product-order-uid.md
  - https://developers.intandem.tech/reference/get_business-payments-v1-products-product-uid.md
  - https://developers.intandem.tech/reference/get_business-payments-v1-products.md
  - https://developers.intandem.tech/reference/get_business-payments-v1-scheduled-payments-rules-uid.md
  - https://developers.intandem.tech/reference/get_business-payments-v1-scheduled-payments-rules.md
  - https://developers.intandem.tech/reference/get_business-payments-v1-taxes-tax-uid.md
  - https://developers.intandem.tech/reference/get_business-payments-v1-taxes.md


# --- truncated at 32 KB (51 KB total) ---
# Full source: https://artifacts.apis.io/vcita/openapi/vcita-scheduled-payment-rule-api-openapi.yml