MagicDoorAPI
SupportOpen MagicDoor
Resident benefit packages

List the resident benefit packages

Returns every package the company has authored, with what each costs and earns. Requires the resident_benefit_packages:read permission.

GET
https://services.magicdoor.com/productexperiences/company-portal/resident-benefit-packages/packages

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.

Response

200 · The company’s packages, including disabled ones, ordered by `sortOrder` and then by id. Not paginated.

idstringrequired

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

namestringrequired

What the package is called to tenants.

tenantPricenumber

The monthly list price the tenant is charged, as a decimal amount.

commitmentMonthsinteger

How many months a tenant commits to when enrolling. At least 3.

sortOrderinteger

Where the package sits when several are offered together. Lower comes first.

enabledboolean

Whether the package is offered for new enrollments. A disabled package keeps its existing enrollments.

exclusivityGroupstring

Packages sharing a group cannot be held at the same time by one tenant. Absent when the package has none.

bundlesobject[]required

The catalog bundles this package is made of.

customLinesobject[]required

Extra perks the property manager adds on top of the bundles.

magicDoorCostnumber

What MagicDoor charges the property manager per enrollment per month, resolved from the company's subscription and falling back to the bundle's catalog default.

customLineCostnumber

The custom lines' costs added together.

estimatedMonthlyProfitPerEnrollmentnumber

tenantPrice minus magicDoorCost minus customLineCost. Can be negative if the package is priced below cost.

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.