Update a PaymentPlan

patch

https://api.vcita.biz/v3/sales/payment_plans/{uid}

Update a PaymentPlan's payment method, or set its status: active resumes a paused plan, cancelled stops an active or paused plan.

Available for Staff Tokens.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uid

string

required

Unique identifier of the PaymentPlan

Body Params

At least one of payment_method_uid or status must be supplied.

payment_method_type

string

enum

The kind of saved payment method charged on every installment. Only a saved card is supported today (e.g., "card")

Allowed:

payment_method_uid

string

length ≤ 16

The unique identifier of the saved payment method to charge. It must belong to the matter's client and use the same payment provider as the business's payment gateway. For card, obtain it from GET /platform/v1/clients/{client_id}/payment/cards (e.g., "c1c2c3c4c5c6c7c8")

status

string

enum

active resumes a paused plan: the failed installment is charged within a few minutes, then payments continue at the same frequency from the resume date. If that charge fails, the plan returns to paused. cancelled stops the plan; installments already collected are not refunded, and for a linked plan they stay applied to the invoice (e.g., "active", "cancelled")

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The updated PaymentPlan

401Missing, expired or invalid bearer token.

403The token is valid but not permitted to perform this action on this business.

404No PaymentPlan with this uid exists for the business.

422Validation failed. Errors use the standard envelope, with field naming the offending parameter and code a machine-readable reason (e.g., missing_field, invalid).