Create a recurring payment plan

POST

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

Creates a SchoolSet recurring payment plan from aligned payment dates, amounts, grace periods, and the selected contract payment method.

AuthorizationBearer

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

This endpoint expects a multipart form.

contract_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 any or nullOptional

wallet_idinteger or nullOptional

secondary_wallet_idinteger or nullOptional

merchant_account_idinteger or nullOptional

fees_prioritylist of integersOptional

notestring or nullOptional

Recurring plan created

statusstringOptional

messagestringOptional

datamap from strings to anyOptional

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/v2/payment/create/recurring/payment-plan \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: multipart/form-data" \
>	-F contract_id='1204' \
>	-F payment_type_id='10' \
>	-F payment_recurring_period_id='1' \
>	-F payment_total_amount='4250' \
>	-F payment_amounts='[
>	425,
>	425,
>	425,
>	425,
>	425,
>	425,
>	425,
>	425,
>	425,
>	425
>	]' \
>	-F payment_dates='[
>	"2024-01-15T09:30:00Z",
>	"2024-01-15T09:30:00Z"
>	]' \
>	-F grace_period='[
>	0,
>	0
>	]'