Generate a pledge payment plan

POST

https://ssuccessv2.com/app/api/v1/fundraising/pledge/generate-plan

Calculates scheduled installments using the recurring period, amount fields, optional installment count, indefinite flag, and start date. The request is cancellable by the frontend while typing.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

payment_recurring_period_idintegerRequired

start_datedateRequired

installmentsintegerOptional>=1

amount_per_installmentdoubleOptional

total_amountdoubleOptional

indefinitebooleanOptional

Response

Generated schedule

statusstring

messagestring

datalist of maps from strings to any

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v1/fundraising/pledge/generate-plan \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"payment_recurring_period_id": 2,
>	"start_date": {},
>	"amount_per_installment": 125,
>	"indefinite": true
>	}'

1	{
2	"status": "success",
3	"message": "",
4	"data": [
5	{}
6	]
7	}