Get resident benefit earnings
Returns what the resident benefit program is earning the company today, and what it would earn if every active lease enrolled. Requires the resident_benefit_packages:read permission.
Authorization
AuthorizationstringrequiredBearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.
Response
200 · Earnings today and the ceiling per package.
activeLeaseCountintegerrequiredHow many leases on the company are neither draft nor ended. It is the base for the potential figures.
activeEnrollmentCountintegerrequiredHow many enrollments are active. Enrollments still pendingActivation are not counted here.
packagesobject[]requiredOne entry per package the company has authored.
actualMonthlyRevenuenumberWhat active enrollments actually bill each month, using each one's effective price rather than the list price.
actualMonthlyCostnumberWhat MagicDoor charges for those same active enrollments each month.
actualMonthlyCustomLineCostnumberWhat the custom lines on those same enrollments cost each month.
actualMonthlyProfitnumberactualMonthlyRevenue minus actualMonthlyCost minus actualMonthlyCustomLineCost.