BeneficiaryCapacity
Active-beneficiary allowance of the plan and current occupancy of the authenticated account.
Properties
| Field | Type | Description |
|---|---|---|
max | integer | Active-beneficiary cap. `-1` means uncapped. |
current | integer | Number of saved active beneficiaries, regardless of the archived filter. |
required | integer | Number of slots needed to create or reactivate accounts in the import job. |
exceeded | boolean | `true` when the import job needs new slots and exceeds the available allowance. |
Used in operations
GET /v1/beneficiariesGET /v1/beneficiaries/imports/{id}GET /v1/beneficiaries/imports/{id}/preview