List recurring payments for a contract

GET

https://ssuccessv2.com/app/api/v1/system/payment/contract/details/payment/plan/recurring/:contract_id

GET

/app/api/v1/system/payment/contract/details/payment/plan/recurring/:contract_id

$ curl https://ssuccessv2.com/app/api/v1/system/payment/contract/details/payment/plan/recurring/1842 \
>      -H "Authorization: Bearer <token>"

1 {
2   "status": "success",
3   "message": "",
4   "data": [
5     {
6       "id": 612,
7       "amount_payment": 750,
8       "allocated_amount": 750,
9       "unallocated_amount": 0,
10       "payment_start_date": {},
11       "currency": "USD",
12       "method": {
13         "id": 2,
14         "title": "Credit card",
15         "sysname": "credit_card"
16       },
17       "type": {
18         "id": 1,
19         "title": "Tuition",
20         "sysname": "tuition"
21       },
22       "status": {
23         "id": 1,
24         "title": "Active"
25       },
26       "payments": [
27         {}
28       ],
29       "allocations": [
30         {}
31       ],
32       "payment_recurring_period": {
33         "id": 1,
34         "name": "Monthly"
35       },
36       "payment_plan": {}
37     }
38   ]
39 }

Returns recurring payment plans and their generated payments for a SchoolSet contract, including payment period, payer, wallet, allocation, and installment totals.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Path parameters

contract_idintegerRequired>=1

SchoolSet contract identifier whose recurring payment plans should be displayed.

Response

Recurring payment plans were loaded for the contract.

statusstring

messagestring

datalist of objects

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error