# Get Agreements

<mark style="color:blue;">`GET`</mark> /v3/customers/me/agreements

## Request

The details below help you form your HTTP requests to this endpoint.

### Headers

You may need to provide specific headers.

<table><thead><tr><th>Name</th><th>Type</th><th data-type="checkbox">Required</th><th>Description</th></tr></thead><tbody><tr><td>customer-token</td><td>string</td><td>true</td><td>Customer's authentication token</td></tr><tr><td>x-version-override</td><td>string</td><td>false</td><td>N/A</td></tr></tbody></table>

## Response

The details below help you understand the responses you could get from this endpoint.

### Samples

Below are samples of responses, with tabs corresponding to returned status code.

{% tabs %}
{% tab title="200" %}

```javascript
[
    {
        "id": "682634e9fbae50001bc06f77",
        "referenceId": "D5ACE9023025",
        "pastDue": 4500,
        "leaseStartDate": "2025-05-22T21:50:58.175Z",
        "estimatedOwnership": 77343,
        "earlyPayoff": 1232,
        "items": [
            {
                "description": "Spinel jewelry over 50",
                "trackingCarrierName": "ups",
                "trackingNumber": "9MTR1T96LAWV",
                "trackingStatus": "delivered"
            }
        ]
    }
]
```

{% endtab %}
{% endtabs %}

### Schema

The response's schema is outlined below.

<table><thead><tr><th>Name</th><th>Type</th><th data-type="checkbox">Required</th><th>Description</th></tr></thead><tbody><tr><td>data</td><td>array</td><td>false</td><td>N/A</td></tr><tr><td>data[].id</td><td>string</td><td>true</td><td>The agreement id</td></tr><tr><td>data[].referenceId</td><td>string</td><td>true</td><td>Agreement reference id</td></tr><tr><td>data[].pastDue</td><td>number</td><td>true</td><td>Past due amount in cents. 0 if not past due.</td></tr><tr><td>data[].leaseStartDate</td><td>date</td><td>true</td><td>The lease start date, based on the first billing date.</td></tr><tr><td>data[].estimatedOwnership</td><td>number</td><td>true</td><td>Estimated amount required to own the item. Defaults to 0 if payoff data is not available.</td></tr><tr><td>data[].earlyPayoff</td><td>number</td><td>true</td><td>Total amount required to pay off the agreement early.</td></tr><tr><td>data[].items</td><td>array</td><td>true</td><td>List of items in this agreement</td></tr><tr><td>data[].items[].description</td><td>string</td><td>true</td><td>Description of the item</td></tr><tr><td>data[].items[].trackingCarrierName</td><td>string</td><td>false</td><td>Name of the shipping carrier for this item</td></tr><tr><td>data[].items[].trackingNumber</td><td>string</td><td>false</td><td>Tracking number assigned by the carrier</td></tr><tr><td>data[].items[].trackingStatus</td><td>string</td><td>false</td><td>Current tracking status of the item.</td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://dev.flexshopper.com/medusa/lease/get-agreements.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.