Create a recurring fundraising payment plan | SchoolSet

Creates scheduled installments for an active fundraising campaign. Payment dates, amounts, grace periods, and the total must have matching and internally consistent values.

Authentication

AuthorizationBearer

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

Request

This endpoint expects a multipart form.

fundraising_idintegerRequired

payment_type_idintegerRequired

payment_recurring_period_idintegerRequired

payment_total_amountdoubleRequired

payment_amountslist of doublesRequired

payment_dateslist of datetimesRequired

grace_periodlist of integersRequired

payment_datamap from strings to anyOptional

wallet_idinteger or nullOptional

secondary_wallet_idinteger or nullOptional

merchant_account_idinteger or nullOptional

donation_type_idinteger or nullOptional

messagestringOptional<=1000 characters

full_namestringOptional<=1000 characters

emailstringOptionalformat: "email"

notestringOptional<=255 characters

parent_student_idinteger or nullOptional

family_student_idinteger or nullOptional

fundraising_donor_idinteger or nullOptional

fundraising_pledge_idinteger or nullOptional

Response

Recurring plan created.

statusstring

messagestring

datamap from strings to any

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v1/fundraising/payment/campaign/create/recurring/payment-plan \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: multipart/form-data" \
>	-F fundraising_id='42' \
>	-F payment_type_id='8' \
>	-F payment_recurring_period_id='2' \
>	-F payment_total_amount='600' \
>	-F payment_amounts='[
>	100,
>	100,
>	100,
>	100,
>	100,
>	100
>	]' \
>	-F payment_dates='[
>	"2024-01-15T09:30:00Z",
>	"2024-01-15T09:30:00Z"
>	]' \
>	-F grace_period='[
>	0,
>	0
>	]'

1	{
2	"status": "success",
3	"message": "Saved",
4	"data": {
5	"id": 88,
6	"fundraising_id": 42,
7	"payment_total_amount": 600,
8	"status": "active"
9	}
10	}