Get Lease By ID

Returns the details of a lease

GET /v3/leases/{leaseId}

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

Path Parameters

The endpoint path expects parameters.

Name	Type	Required	Description
leaseId	string		Lease agreement identifier

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

{
    "data": {
        "leaseId": "\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1YTk...",
        "contract": "...base64 html contract",
        "leaseStatus": "signed",
        "frequency": "weekly",
        "term": 52,
        "payment": 17.28,
        "cashPrice": 400,
        "costOfRental": 440,
        "isExpired": false
    }
}

400

404

Schema

The response's schema is outlined below.

Name	Type	Required	Description
data	object		N/A
data.leaseId	string		A unique identifier for the generated lease
data.contract	string		The lease contract, expressed as base64-encoded HTML
data.leaseStatus	string		N/A
data.frequency	string		Frequency of lease payments
data.term	number		Term of the lease
data.payment	number		Periodic payment with tax
data.cashPrice	number		Cash price of the lease
data.costOfRental	number		Cost of the lease
data.isExpired	boolean		Whether the lease has expired