Update Scheduled Payment Rule

put

https://api.vcita.biz/business/payments/v1/scheduled_payments_rules/{uid}

Overview

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

Payment Gateway: Business must have a payment gateway configured that supports recurring payments (Stripe, vcitaPayments, Square). PayPal is NOT supported for scheduled payments.
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.
Existing Rule: The scheduled payment rule must already exist (created via POST endpoint).

The start_date field must be in ISO date format (YYYY-MM-DD) and must be in the future relative to UTC timezone.

Language

Credentials

Bearer

JWT

Click Try It! to start a request and see the response here!