List upcoming contract payments

GET

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

GET

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

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

1 {
2   "status": "success",
3   "message": "",
4   "data": [
5     {
6       "id": 9030,
7       "amount_payment": 750,
8       "base_amount_payment": 750,
9       "payment_date": {},
10       "days_until_scheduled": 12,
11       "scheduled_due_status": "upcoming",
12       "currency": "USD",
13       "balance_after_collected_payment": 3000,
14       "payer": {
15         "id": 417,
16         "name": "Rivera Family"
17       },
18       "status": {
19         "id": 2,
20         "title": "Scheduled",
21         "description": "Payment is scheduled",
22         "group_name": "scheduled"
23       },
24       "method": {
25         "id": 2,
26         "title": "Credit card",
27         "sysname": "credit_card"
28       },
29       "type": {
30         "id": 1,
31         "title": "Tuition",
32         "sysname": "tuition"
33       },
34       "allocations": [
35         {}
36       ]
37     }
38   ]
39 }

Returns scheduled and otherwise upcoming payments for a SchoolSet contract, with payer, status, payment method, allocation, and balance information for the payment timeline.

Authentication

AuthorizationBearer

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

Path parameters

contract_idintegerRequired>=1

SchoolSet contract identifier whose upcoming payments should be displayed.

Response

Upcoming payments 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