Generate a recurring payment plan

POST

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

Generates a plan for the active school from installment or total amount inputs. The frontend aborts a prior in-flight request before posting a new plan.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

payment_recurring_period_idintegerRequired>=1

start_datedateRequired

indefinitebooleanOptional

installmentsintegerOptional>=1

amount_per_installmentdoubleOptional>=0

total_amountdoubleOptional>=0

Response

Generated plan values.

statusstring

messagestring

datamap from strings to any

Errors

401

Unauthorized Error

$	curl -X POST https://ssuccessv2.com/app/api/v1/portal/payment/generate-plan \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"payment_recurring_period_id": 3,
>	"start_date": {}
>	}'

1	{
2	"status": "success",
3	"message": "",
4	"data": {
5	"payment_start_date": {},
6	"amount_payment": "200.00",
7	"number_of_repetitions": 12,
8	"total_amount": "2400.00"
9	}
10	}