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.
customer-token
string
Customer's authentication token
x-version-override
string
N/A
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.
Schema
The response's schema is outlined below.
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
Last updated
Was this helpful?