API Reference

Update a PaymentPlan

patch
https://api.vcita.biz/v3/sales/payment_plans/

Update a PaymentPlan. Only two fields are accepted:

  • payment_method_uid (with payment_method_type) — charge a different saved payment method from the next installment onwards.
  • status — set to cancelled to stop the plan. No further installment is collected. Installments already collected are not refunded, and for a linked plan they stay applied to the invoice. cancelled is the only status a client may set, and only while the plan is active.

Available for Staff Tokens.

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

Unique identifier of the PaymentPlan

Body Params

At least one of payment_method_uid or status must be supplied.

string
enum

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

Allowed:
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")

string
enum

Set to cancelled to stop the plan. This is the only value a client may set (e.g., "cancelled")

Allowed:
Responses

Updated about 1 hour ago

Did this page help you?
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 about 1 hour ago

Did this page help you?