Get Lease By ID

Returns the details of a lease.

/v3/leases/{leaseId}

GET https://apis.sandbox.flexshopper.com/v3/leases/{leaseId}

Path Parameters

Name	Type	Description
leaseId	string	Lease agreement identifier

Headers

Name	Type	Description
Customer-Token	string	Customer's authentication token
Authorization	string	Authentication token

200 Result successfully retrieved.

{
  "data": {
    "leaseId": "\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1YTk...",
    "contract": "...base64 html contract",
    "leaseStatus": "signed"
  }
}

404 Could not find the lease

{
  "error": {
    "statusCode": 404,
    "code": "LeaseNotFound",
    "message": "The lease was not found",
    "data": {}
  }
}

Response Parameters

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the lease info

Key	Type	Description
leaseId	string	A unique identifier for the generated lease.
contract	string	The lease contract, expressed as base64-encoded HTML.
leaseStatus	string	The current status of this lease, one of "signed" or "unsigned".
frequency	string	The frequency of payments, such as "weekly".
term	number	The term/length of the lease.
payment	number	The term payment amount with tax.
cashPrice	number	The total "Same as Cash" price of the lease, if available.
costOfRental	number	The lease total minus the cost.