List recurring payment plans for a fund

GET

https://ssuccessv2.com/app/api/v1/fundraising/fund/:id/payment-plans

GET

/app/api/v1/fundraising/fund/:id/payment-plans

$ curl https://ssuccessv2.com/app/api/v1/fundraising/fund/12/payment-plans \
>      -H "Authorization: Bearer <token>"

1 {
2   "status": "success",
3   "message": "",
4   "data": [
5     {
6       "id": 91,
7       "payment_total_amount": 1200,
8       "payment_start_date": {},
9       "type": {
10         "id": 6,
11         "title": "ACH"
12       },
13       "status": {
14         "id": 1,
15         "title": "Active"
16       },
17       "payments": [
18         {
19           "id": 501
20         }
21       ],
22       "payment_source": "schoolset",
23       "payment_recurring_period": {
24         "id": 2,
25         "title": "Monthly"
26       },
27       "payer_id": 44,
28       "payer_type": "donor",
29       "payer": {
30         "id": 44,
31         "name": "Jamie Rivera"
32       },
33       "donor": {
34         "id": 44,
35         "name": "Jamie Rivera"
36       },
37       "note": "Annual giving plan"
38     }
39   ]
40 }

Returns recurring plans whose payment allocations belong to the selected fund.

Authentication

AuthorizationBearer

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

Path parameters

idintegerRequired

Fund ID

Response

Recurring plans for the fund.

statusstring

messagestring

datalist of objects

Errors

401

Unauthorized Error

404

Not Found Error