Get Agreements

Retrieve all agreements associated with the authenticated customer.

GET /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.

Name	Type	Required	Description
customer-token	string		Customer's authentication token
x-version-override	string		N/A

Query

You may provide query parameters to filter the output.

Name	Type	Required	Description
page	number		Page number to retrieve
limit	number		Maximum number of records per page
signed	boolean		Filter agreements by signed status
sort	string		Sort agreements
orderBy	string		Property to order by

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.

200

[
    {
        "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"
            }
        ]
    }
]

Schema

The response's schema is outlined below.

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