Delete a recurring payment

Stops a recurring payment. Set deleteAllPayments to true to also remove the payments it has already recorded.

DELETE

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.

leaseIdstringrequired

The lease the recurring payment is on. A Snowflake id, sent as a decimal string.

example: 1830472847398404096

recurringPaymentIdstringrequired

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

example: 1862019384756201984

application/json

deleteAllPaymentsbooleanrequired

Whether to also remove the payments this has already recorded.