MagicDoorAPI
SupportOpen MagicDoor
Lease charges

Update a recurring payment

Replaces a recurring payment's amount, frequency, dates, tenant and method. Set updatePastPayments to true to also change the payments it has already recorded.

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

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 the recurring payment is on. A Snowflake id, sent as a decimal string.

example: 1830472847398404096
recurringPaymentIdstringrequired

The recurring payment to update. A Snowflake id, sent as a decimal string.

example: 1862019384756201984

Body

application/json

amountnumberrequired

New amount, as a decimal of at least 1.

paymentFrequencyenum<string>required

New frequency.

monthlyweeklydailymonthly2XSplitquarterlyyearly
startFromstring · daterequired

New first date.

updatePastPaymentsbooleanrequired

Whether to apply the change to payments this has already recorded.

endstring · date

New last date. Must be later than startFrom.

tenantIdstring

Which tenant is paying. A Snowflake id, sent as a decimal string.

descriptionstring

New note. 1 to 1000 characters.

paymentMethodenum<string>

How the tenant pays. Left out, this resets to other.

checkcashiersCheckmoneyOrdercashother
referencestring

New reference. Up to 150 characters.

Response

200 · The updated recurring payment.

idstring

Id of the recurring payment. A Snowflake id, sent as a decimal string.

leaseIdstring

The lease it pays. A Snowflake id, sent as a decimal string.

tenantIdstring

The tenant it is recorded against. A Snowflake id, sent as a decimal string.

portfolioIdstring

Portfolio it rolls up to. A Snowflake id, sent as a decimal string.

propertyIdstring

Property it is on. A Snowflake id, sent as a decimal string.

unitIdstring

Unit it is on. A Snowflake id, sent as a decimal string.

amountnumber

Amount recorded each period, as a decimal.

paymentFrequencyenum<string>

How often it is recorded.

monthlyweeklydailymonthly2XSplitquarterlyyearly
paymentMethodenum<string>

How the tenant pays.

achdebitCardwalletcreditCardcheckcashiersCheckmoneyOrdercashother
descriptionstring

Note on the payment.

referencestring

External reference carried on each payment.

lastPaymentstring · date

When it last recorded a payment.

nextPaymentstring · date

When it next records one.

startFromstring · date

First date it records a payment.

endstring · date

Last date it records one. Absent when it runs indefinitely.

statusenum<string>

Whether it is still running, has finished, or is about to record a payment.

activeendeddueSoon
tenantobject

The tenant it is recorded against.

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 recurring payment matched the id, or it belongs to another company.