Resident benefit packages

List the benefit bundle catalog

Returns the bundles that can currently be composed into a package, with MagicDoor's default cost and a suggested tenant price so margins can be previewed before saving. Requires the resident_benefit_packages:read permission.

GET

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

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 bundles open for new packages. Retired bundles are not listed.

bundlesobject[]required

One entry per bundle.

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.

defaultMagicDoorCost is the catalog default, not necessarily what this company pays. The magicDoorCost on a saved package is resolved from the company's subscription and only falls back to this default when the subscription does not price the bundle.

Request

curl --request GET \
  --url 'https://services.magicdoor.com/productexperiences/company-portal/resident-benefit-packages/bundle-catalog' \
  --header 'Authorization: Bearer <token>'

Response

{
  "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",
      "tierRank": 1,
      "defaultCommitmentMonths": 12,
      "defaultMagicDoorCost": 10,
      "suggestedRetail": 17
    }
  ]
}