MagicDoorAPI
SupportOpen MagicDoor
Lease charges

List recurring payments

Returns the payments that are recorded automatically on the lease each period, such as a standing cheque. Finished and inactive ones are left out unless you ask for them.

GET
https://api.portal.magicdoor.com/company-app/leases/{leaseId}/charges/recurring-payments

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 whose recurring payments you want. A Snowflake id, sent as a decimal string.

example: 1830472847398404096

Query parameters

includeEndedboolean

Set to true to include recurring payments that have already finished.

default: false
includeInactiveboolean

Set to true to include recurring payments that have been switched off.

default: false

Response

200 · The recurring payments on the lease.

recurringPaymentsRecurringLeasePayment[]

The recurring payments.

400 · The request failed validation. `errors` maps each field name to what was wrong with it.

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

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