API Reference

Update Scheduled Payment Rule

put
https://api.vcita.biz/business/payments/v1/scheduled_payments_rules/

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Scheduled Payment Rule UID

Body Params
scheduled_payments_rule
object
required
Responses

Updated 2 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago