Lease charges

List recurring credits

Returns the credits that repeat on the lease, such as a standing allowance. Credits that have already finished are left out unless you ask for them.

GET

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

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

example: 1830472847398404096

Query parameters

includeEndedboolean

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

default: false

Response

200 · The recurring credits on the lease.

recurringCreditsRecurringLeaseCredit[]

The recurring credits.

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.

Request

curl --request GET \
  --url 'https://api.portal.magicdoor.com/company-app/leases/1830472847398404096/charges/recurring-credits' \
  --header 'Authorization: Bearer <token>'

Response

{
  "recurringCredits": [
    {
      "id": "1861019384756201984",
      "amount": 100,
      "creditFrequency": "monthly",
      "description": "On-site caretaker allowance",
      "lastCredit": "2026-08-01",
      "nextCredit": "2026-09-01",
      "start": "2026-03-01",
      "status": "active"
    }
  ]
}