---
updatedAt: 2026-08-27T13:52:09.000Z
agentTools:
  projectIndex: https://docs.youlend.com/llms.txt
---

# Gets the list of merchants eligible for renewal.

This is a paginated API where each request returns a list of all your merchants which are eligible for more financing. This includes and identifies those that would be renewing early, if for example they wish to get further funding before they have repaid their existing loan with YouLend.

The API returns a maximum of 250 merchants, along with their identifiers and information. If the `totalResults` exceeds this figure, you can use pagination to return further merchants with the `Offset` parameter.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Onboarding",
    "description": "Through this API you can can initiate the process of onboarding a borrower with YouLend",
    "contact": {
      "name": "Mark Ufland",
      "email": "mark.ufland@youlend.com"
    },
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://partners.staging-youlendapi.com/onboarding"
    }
  ],
  "paths": {
    "/Renewals/GetEligibleForRenewal": {
      "get": {
        "tags": [
          "GET Details"
        ],
        "summary": "Gets the list of merchants eligible for renewal.",
        "parameters": [
          {
            "name": "Limit",
            "in": "query",
            "schema": {
              "maximum": 250,
              "minimum": 1,
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "Offset",
            "in": "query",
            "schema": {
              "minimum": 0,
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AlwaysOnRenewalsResponse"
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable Content",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "default": {
            "description": "Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "AlwaysOnRenewalModel": {
        "type": "object",
        "properties": {
          "loanId": {
            "type": "string",
            "description": "Gets or sets the loan id.",
            "format": "uuid"
          },
          "leadId": {
            "type": "string",
            "description": "Gets or sets the lead id.",
            "format": "uuid"
          },
          "isEligibleForRenewal": {
            "type": "boolean",
            "description": "Gets or sets a value indicating whether the lead is eligible for renewal."
          },
          "hasActiveLoan": {
            "type": "boolean",
            "description": "Gets or sets a value indicating whether the lead has an active loan."
          },
          "hasPreviouslyRenewed": {
            "type": "boolean",
            "description": "Gets or sets a value indicating whether the lead has previously renewed."
          },
          "thirdPartyCustomerId": {
            "type": "string",
            "description": "Gets or sets the third party customer id.",
            "nullable": true
          },
          "maxDisplayableFundableAmount": {
            "type": "number",
            "description": "Gets or sets the max displayable fundable amount.",
            "format": "double"
          },
          "currencyCode": {
            "type": "string",
            "description": "Gets or sets the currency code.",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "AlwaysOnRenewalsResponse": {
        "type": "object",
        "properties": {
          "metadata": {
            "$ref": "#/components/schemas/PagedMetaData"
          },
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AlwaysOnRenewalModel"
            },
            "description": "Gets or sets the records.",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "PagedMetaData": {
        "type": "object",
        "properties": {
          "totalResults": {
            "type": "integer",
            "description": "Gets or sets the total results.",
            "format": "int32"
          },
          "currentOffset": {
            "type": "integer",
            "description": "Gets or sets the current offset.",
            "format": "int32"
          },
          "nextOffset": {
            "type": "integer",
            "description": "Gets or sets the next offset.",
            "format": "int32",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "nullable": true
          },
          "title": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "detail": {
            "type": "string",
            "nullable": true
          },
          "instance": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": {}
      }
    },
    "securitySchemes": {
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://youlend-stag.eu.auth0.com/oauth/token",
            "scopes": {}
          }
        }
      }
    }
  },
  "security": [
    {
      "oauth2": []
    }
  ],
  "tags": [
    {
      "name": "GET Details"
    }
  ]
}
```