Create

Create

After a client chooses an option from the request method, they can call the Create method to confirm and begin that Plan.

Endpoints
POST /api/plan/create

Request Object

fieldtypedescription
emailnumberemail of the user that created this plan
datestringISO 8601 date of creation (YYYY-MM-DD)
namestringname for the plan
principalstringtotal amount borrowed at creation
basestringamount to be paid per month
interestnumberinterest to be paid as a percentage (APR)
installmentsnumbernumber of months to repay the amount

Response Object

fieldtypedescription
idnumberunique identifier
emailstringemail of the user that created this plan
namestringname for the plan
datestringISO 8601 date of creation (YYYY-MM-DD)
principalnumbertotal amount borrowed at creation
interestnumberinterest to be paid as a percentage (APR)