Get Eligible Plans
Header Parameters
Optional correlation ID associated with the request, comprised of alphanumeric or hyphen characters up to 36 characters in length.
Query Parameters
Platform GUID of the plan year (BenefitsPackage.PackageSystemId).
Platform GUID of the participant (person_id).
Response
Successfully retrieved eligible plans.
Response Attributes
Per-plan details, one entry for each active enrolled offering.
Show child attributes
Plans merged (aggregated) by expense account base type.
Show child attributes
Indicates whether the consumer files claims against a specific plan or against an account type. WEX.Benefits.Claims.Domain.Enums.FileByType.FileByPlan when any account type groups more than one plan (the caller must disambiguate); WEX.Benefits.Claims.Domain.Enums.FileByType.FileByAccount when each account type has exactly one underlying plan.
The date the participant's current status (e.g. Active, Terminated) took effect
(ParticipantStatus.StatusEffectiveDt).
Null when no status record exists for the participant, or when all status records
have an effective date in the future (i.e. no record with EffectiveDate <= UtcNow).
Invalid request parameters.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unauthorized. Authentication failed or identity could not be resolved.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
No eligible plans found for the given consumer and plan year.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Internal server error.
Unexpected error
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Base URL
Production:
Sandbox: