Lease renewals

Calculate a suggested renewal offer

Works out the renewal MagicDoor would suggest for this lease — a new end date, the rent changes to go with it, and when the offer would expire. Nothing is stored; use it to prefill the create-offer form.

GET
https://api.portal.magicdoor.com/company-app/leases/{leaseId}/renewals/calculate

Authorization

Authorizationstringrequired
Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

leaseIdstringrequired

The lease to calculate a renewal for. A Snowflake id, sent as a decimal string.

example: 1830472847398404096

Response

200 · The suggested offer.

newEndDatestring · date

The end date the renewal would give the lease.

recurringChargeChangesRecurringChargeChange[]

Changes to the lease's existing recurring charges. One entry per charge you are changing.

offerExpiresstring · date-time

When the offer would stop being open to the tenant.

401 · The access token is missing, expired, or not for this company.

404 · No lease matched the id, or it belongs to another company.