Generate a recurring payment plan

POST

https://ssuccessv2.com/app/api/v2/payment/generate-plan

Calculates dated installment amounts for the selected recurring period from the supplied total, installment, and start-date inputs.

AuthorizationBearer

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

This endpoint expects an object.

payment_recurring_period_idintegerRequired

start_datedateRequired

installmentsintegerOptional>=1

amount_per_installmentdoubleOptional>=0

total_amountdoubleOptional>=0

indefinitebooleanOptional

The generated installment schedule was returned.

statusstringOptional

messagestringOptional

datalist of objectsOptional

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v2/payment/generate-plan \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"payment_recurring_period_id": 2,
>	"start_date": {},
>	"installments": 10,
>	"amount_per_installment": 125,
>	"total_amount": 1250,
>	"indefinite": false
>	}'