Get the resident benefit settings

Returns the company's resident benefit program settings, every package it has authored, and how many enrollments are currently live. Requires the resident_benefit_packages:read permission.

GET

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

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 program settings and packages.

enrolledInProgrambooleanrequired

Whether the resident benefit program is switched on for the company. New companies start switched on.

enrollmentDatestring · date-time

When the program was first switched on, in the company's timezone. Absent until then.

lockRetailPriceDuringCommitmentbooleanrequired

When on, an enrollment keeps the price it was sold at for the length of its commitment even if the list price changes. When off, a list-price change reaches existing commitments at their next charge.

recurringLeaseChargeChartOfAccountIdstringrequired

The revenue chart of account the tenant's monthly benefit charge is posted to. Defaults to 430600.

companyExpenseChartOfAccountIdstringrequired

The expense chart of account MagicDoor's monthly charge to the property manager is posted to. Defaults to 630500.

activeEnrollmentCountintegerrequired

How many enrollments across the company are still live — counting both pendingActivation and active.

packagesobject[]required

Every package the company has authored, including disabled ones.

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.

{ "enrolledInProgram": true, "enrollmentDate": "2026-02-03T11:20:07", "lockRetailPriceDuringCommitment": true, "recurringLeaseChargeChartOfAccountId": "430600", "companyExpenseChartOfAccountId": "630500", "activeEnrollmentCount": 48, "packages": [ { "id": "1841776203441090560", "name": "Resident Benefits", "tenantPrice": 25, "commitmentMonths": 12, "sortOrder": 0, "enabled": true, "exclusivityGroup": "pinata-tier", "bundles": [ { "bundleKey": "basic_v1", "name": "Resident Benefit Package", "descriptionMarkdown": "Build your credit and get rewarded — just by paying rent.\n\n- **Credit building** — your on-time rent payments are reported to credit bureaus every month.\n- **Rent rewards** — earn points and rewards for paying rent.\n- **Identity protection** — monitoring and alerts that help keep your identity safe.", "features": [ "Credit building", "Rent rewards", "Identity protection" ], "provider": "pinata", "exclusivityGroup": "pinata-tier", "active": true } ], "customLines": [ { "title": "Quarterly filter delivery", "description": "Air filters shipped to the unit every three months.", "provider": "FilterTime", "cost": 3 } ], "magicDoorCost": 10, "customLineCost": 3, "estimatedMonthlyProfitPerEnrollment": 12 } ] }