Rent Revisions

Get a rent revision

Retrieves a single recorded rent revision by its identifier.

Usage Example

curl -X GET https://api.faireplace.com/api/leases/660e8400-e29b-41d4-a716-446655440001/rent-revisions/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_API_KEY"
get/leases/{lease_id}/rent-revisions/{revision_id}

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/rent-revisions/{revision_id}
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Lease ID

revision_idstring uuid required

Rent revision ID

Response

Revision retrieved successfully

idstring uuid required

Unique identifier of the revision record.

tenant_idstring required

Tenant (organization) identifier owning this revision.

lease_idstring uuid required

Lease to which the revision applies.

index_value_idstring uuid required

Identifier of the IRL index value used for the revision.

increase_cap_idstring uuid nullable

Identifier of the increase cap applied, if any.

special_period_idstring uuid nullable

Identifier of the special (legislative) period applied, if any.

revision_datestring date required

Effective date of the revision (ISO 8601).

previous_amountnumber double required

Rent amount before the revision (in euros).

new_amountnumber double required

Rent amount after the revision (in euros).

percentage_changenumber double required

Percentage change between previous and new rent.

capped_increaseboolean required

Whether the increase was capped by a legislative increase cap.

revision_detailsobject nullable

Free-form JSON details about the revision computation.

created_atstring date-time required

Creation timestamp (ISO 8601).

updated_atstring date-time required

Last update timestamp (ISO 8601).

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tenant_id": "tenant_123",
  "lease_id": "660e8400-e29b-41d4-a716-446655440001",
  "index_value_id": "770e8400-e29b-41d4-a716-446655440002",
  "increase_cap_id": "880e8400-e29b-41d4-a716-446655440003",
  "special_period_id": "990e8400-e29b-41d4-a716-446655440004",
  "revision_date": "2025-07-01",
  "previous_amount": 1200,
  "new_amount": 1236,
  "percentage_change": 3,
  "created_at": "2025-06-15T10:30:00Z",
  "updated_at": "2025-06-15T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.