API Reference

Get all PaymentPlans

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

Overview

Get a list of PaymentPlans for the business, newest updated first. Use payment_request_uid to find the plan collecting against a specific invoice, and status to list only running plans.

Available for Staff Tokens.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number
1 to 10000
Defaults to 1

Page number of results.

number
1 to 100
Defaults to 25

How many items to return per page. Max: 100

string
Defaults to updated_at:desc

Sort by fields. Example: sort=next_payment_date:asc,created_at:desc

string

Return only plans linked to this payment request. Combine with status=active to check whether an invoice already has a running plan.

string
enum

Return only plans in this state. Every plan that stopped early is cancelled; read cancel_reason for why.

Allowed:
string

Return only plans belonging to this matter.

string

Return only plans belonging to matters of this client.

Responses

Updated about 8 hours 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 8 hours ago

Did this page help you?