# Pay plans

A pay plan represents a payment where the Spenda platform has extended a loan to make a purchase that
the customer pays back over one or more instalments.

 * **POST** [/payplans/offer](/openapi/april-public/operation/CreatePayPlanOffer/) Create a pay plan offer for a registered and KYC'd merchant customer
* **GET** [/payplans](/openapi/april-public/operation/QueryPayPlans/) Return a paginated list of matching pay plans
* **POST** [/payplans](/openapi/april-public/operation/CreatePayPlan/) Create a pay plan and payment token from a successful pay plan offer
* **GET** [/payplans/{payPlanId}](/openapi/april-public/operation/GetPayPlan/) Return details of a pay plan
* **POST** [/payplans/max](/openapi/april-public/operation/CalculatePayPlanMaxLoan/) Return the maximum loan amount the given customer is currently eligible for
* **POST** [/payplans/parameters](/openapi/april-public/operation/CalculatePayPlanParameters/) Calculate the pay plan parameters for the given amount and list of variants


## Create Pay Plan Offer

 - [POST /payplans/offer](https://docs.meetapril.io/openapi/april-public/pay-plans/createpayplanoffer.md): Create a pay plan offer for a registered and KYC'd merchant customer.
The offer returned must be used to create a pay plan within 10 minutes.
After this point, generate a new offer by calling this endpoint again.

If called with a customer JWT, the pay plan is created for that customer,
otherwise the customer must be provided via the Customer-Id request header.

## Query Pay Plans

 - [GET /payplans](https://docs.meetapril.io/openapi/april-public/pay-plans/querypayplans.md): Return a paginated list of matching pay plans.

## Create Pay Plan

 - [POST /payplans](https://docs.meetapril.io/openapi/april-public/pay-plans/createpayplan.md): Create a pay plan and payment token from a successful pay plan offer.
The payment token can be used to pay for an order for the matching amount and merchant.

If called with a customer JWT, the pay plan is created for that customer,
otherwise the customer must be provided via the Customer-Id request header.

## Get Pay Plan

 - [GET /payplans/{payPlanId}](https://docs.meetapril.io/openapi/april-public/pay-plans/getpayplan.md): Return details of a pay plan.

## Calculate Pay Plan Max Loan

 - [POST /payplans/max](https://docs.meetapril.io/openapi/april-public/pay-plans/calculatepayplanmaxloan.md): Return the maximum loan amount the given customer is currently eligible for.

## Calculate Pay Plan Parameters

 - [POST /payplans/parameters](https://docs.meetapril.io/openapi/april-public/pay-plans/calculatepayplanparameters.md): Calculate the pay plan parameters for the given amount and list of variants. 

Beta release - This endpoint is close to being finalised but non-backward compatible changes to parameters and behaviour may still occur.