Skip to main content

Preview Installment Payment Calendar

GET 
/api/v2/installment-plans/preview

The payment calendar the invoice screen shows before the invoice exists.

Gated on invoice creation, like /selectable: seeing what you are about to offer is part of raising an invoice. scheduled_on is the invoice due date, which anchors the first payment; installments_start_date moves every payment after it, and defaults to following the first when omitted. plan_id is optional -- without one the amount resolves the plan, which is what an invoice carrying no plan would do at checkout.

One entry per schedule the plan offers at this amount: a plan may hold several, and the payer is the one who finally picks between them.

Request​

Responses​

Successful Response