List recurring payment plans for a campaign

GET

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

GET

/app/api/v1/fundraising/campaign/:id/recurring/payment-plans

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

1 {
2   "status": "success",
3   "message": "",
4   "data": {
5     "items": [
6       {
7         "id": 6001,
8         "payment_total_amount": 1200,
9         "payment_start_date": {},
10         "type": {
11           "id": 2,
12           "title": "Recurring"
13         },
14         "status": {
15           "id": 1,
16           "title": "Active"
17         },
18         "payments_count": 12,
19         "payment_source": "portal",
20         "payment_recurring_period": {
21           "id": 2,
22           "title": "Monthly"
23         },
24         "payer_id": 44,
25         "payer_type": "Family",
26         "payer": {
27           "id": 44,
28           "name": "David Cohen",
29           "family_student_id": 44
30         },
31         "donor": null,
32         "note": "Annual giving commitment"
33       }
34     ],
35     "meta": {
36       "current_page": 1,
37       "last_page": 1,
38       "per_page": 25,
39       "total": 1,
40       "from": 1,
41       "to": 1
42     }
43   }
44 }

Returns server-paginated recurring plans for the campaign. Filtering uses filter fields such as start_date, payment_type, amount, payment_source, of_payments, frequency, and status.

Authentication

AuthorizationBearer

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

Path parameters

idintegerRequired

Query parameters

pageintegerOptional>=1

per_pageintegerOptional1-200

sortstringOptional

filter[search]stringOptional

filter[payment_type][]list of stringsOptional

filter[status][]list of stringsOptional

filter[frequency][]list of stringsOptional

filter[start_date][]list of stringsOptional

filter[amount][]list of stringsOptional

filter[of_payments][]list of stringsOptional

Response

Paginated recurring plans

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error