Update a recurring fundraising payment plan | SchoolSet

Updates the installments and payment settings of an existing fundraising recurring plan. The controller currently executes its live update service flow after a commented legacy implementation.

Authentication

AuthorizationBearer

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

Path parameters

payment_recurring_idintegerRequired

Request

This endpoint expects a multipart form.

payment_recurring_period_idintegerRequired

payment_total_amountdoubleRequired

old_payment_idslist of integersOptional

old_payment_amountslist of doublesOptional

old_payment_dateslist of datetimesOptional

old_grace_periodlist of integersOptional

new_payment_amountslist of doublesOptional

new_payment_dateslist of datetimesOptional

new_grace_periodlist of integersOptional

payment_datamap from strings to anyOptional

wallet_idinteger or nullOptional

secondary_wallet_idinteger or nullOptional

merchant_account_idinteger or nullOptional

messagestringOptional<=1000 characters

emailstringOptionalformat: "email"

notestringOptional<=255 characters

Response

Recurring plan updated.

statusstring

messagestring

datamap from strings to any

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v1/fundraising/payment/campaign/update/88/recurring/payment-plan \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: multipart/form-data" \
>	-F payment_recurring_period_id='2' \
>	-F payment_total_amount='600'

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