API Reference›Servicing Plane›Hardship›Retire a policy version

Retire a policy version

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/admin/hardship-policies/{programCode}/versions/{versionId}/retireImplementedBearer token ·ACTIVATE_SERVICING_HARDSHIP_POLICY

Takes a version out of force so it governs no new selections. Existing cases keep the version their decisions were evaluated under.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/admin/hardship-policies/$PROGRAM_CODE/versions/$VERSION_ID/retire \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "Superseded by the 2026 revision of the medical-leave programme.",
  "expectedVersion": 3
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/admin/hardship-policies/${programCode}/versions/${versionId}/retire`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "reason": "Superseded by the 2026 revision of the medical-leave programme.",
  "expectedVersion": 3
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/admin/hardship-policies/{program_code}/versions/{version_id}/retire",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "reason": "Superseded by the 2026 revision of the medical-leave programme.",
  "expectedVersion": 3
},
)

{
  "resourceId": 9302,
  "changes": {
    "programVersionId": 9302,
    "operation": "RETIRE"
  }
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "409",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "idempotency.request.in.flight",
  "errors": []
}

Path & query parameters

Field	Type	Description
LendEasy-Tenant required in header	string	Opaque active LendEasy tenant-registry identifier. Supply exactly one instance; no alternate tenant selector is accepted.
programCode required in path	string	Stable opaque programCode identifier.
versionId required in path	string	Stable opaque version identifier.
Idempotency-Key optional in header	string	Optional replay key for this logical mutation. Omission creates a fresh server-owned key for this attempt; blank, repeated, or longer-than-50-character values are rejected.

Body parameters

Field	Type	Description
reason required	string
expectedVersion optional	integer

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/admin/hardship-policies/$PROGRAM_CODE/versions/$VERSION_ID/retire \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "Superseded by the 2026 revision of the medical-leave programme.",
  "expectedVersion": 3
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/admin/hardship-policies/${programCode}/versions/${versionId}/retire`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "reason": "Superseded by the 2026 revision of the medical-leave programme.",
  "expectedVersion": 3
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/admin/hardship-policies/{program_code}/versions/{version_id}/retire",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "reason": "Superseded by the 2026 revision of the medical-leave programme.",
  "expectedVersion": 3
},
)

{
  "resourceId": 9302,
  "changes": {
    "programVersionId": 9302,
    "operation": "RETIRE"
  }
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "409",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "idempotency.request.in.flight",
  "errors": []
}