MagicDoorAPI
SupportOpen MagicDoor
Resident benefit packages

List a lease's benefit enrollments

Returns the live enrollments on one lease with both sides of the money — what each tenant pays and what MagicDoor charges the property manager for it. Requires the resident_benefit_packages:read permission.

GET
https://services.magicdoor.com/productexperiences/company-portal/resident-benefit-packages/leases/{leaseId}/enrollments

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, as a Snowflake id in decimal string form.

example: 1839884127209783296

Response

200 · The lease's enrollments that are `pendingActivation` or `active`. Cancelled ones are left out, and an empty array comes back when there are none or the lease is not this company's. Not paginated.

idstringrequired

The enrollment, as a Snowflake id in decimal string form.

tenantIdstringrequired

The enrolled tenant.

packageIdstringrequired

The package the tenant is enrolled in.

statusenum<string>required

Where the enrollment stands. Only pendingActivation and active appear in this list.

pendingActivationactivecancelled
effectiveRetailPricenumberrequired

What the tenant is billed each month — the override if one is set, otherwise the snapshot or the current list price.

magicDoorCostnumberrequired

What MagicDoor charges the property manager for this enrollment each month, resolved live from the company's subscription.

cancelAtstring · date-time

When a scheduled cancellation takes effect. Absent when nothing is scheduled.

401 · The request carried no valid access token.

403 · The caller is not a property manager, or is missing the `resident_benefit_packages:read` permission.