---
title: "Repayment Schedule"
description: "Generate detailed repayment breakdowns to help customers plan their cash flow"
---

> For the complete documentation index, see [llms.txt](/llms.txt).

The repayment schedule endpoint generates a detailed breakdown of loan repayments for a specific confirmed offer.
This helps customers understand exactly what they'll pay and when, building confidence and transparency before they commit.

## Why repayment schedules matter to your customers

Showing customers a clear repayment schedule upfront helps them plan their cash flow, compare different loan amounts, and make informed decisions.
Transparency around repayments improves conversion rates and reduces questions later in the process.

## How it works

<Steps>
  <Step title="Retrieve a confirmed offer">
    First, retrieve the customer's offers using `GET /offers/`.
    You'll need the `offer_id` of a confirmed offer – repayment schedules are only generated for confirmed offers.
  </Step>
  <Step title="Request the repayment schedule">
    Use the `offer_id` to generate a repayment schedule:

    ```http
    GET /offers/{offer_id}/repayment_schedule/
    ```
  </Step>
  <Step title="Customise with parameters (optional)">
    You can optionally include query parameters:

    - **`amount=[number]`** – Sets a simulated draw down amount (minimum 100, maximum is the offer max amount).
    - **`pay_off_early_on=[date]`** – Simulates early repayment; specify the last payment date in the format `YYYY-MM-DD`.

    Requests can include none, either, or both parameters.
  </Step>
</Steps>

<Info>
**PDF output**: An HTTP request with an `Accept` header of `application/pdf` will generate a PDF document with the proposed repayment schedule and the applicant's information.
</Info>

<Warning>
**Note**: This endpoint only works for confirmed offers.
</Warning>