# List SubscriberFlex

Lists all SubscriberFlex for the given subscriberID and groupID and planID

Endpoint: GET /subscribers/{subscriberID}/groups/{groupID}/plans/{planID}/flexes
Version: v1
Security: apiKeyAuth, bearerAuth

## Header parameters:

  - `vbasoftware-database` (string, required)
    Target database

## Path parameters:

  - `subscriberID` (string, required)
    Subscriber ID

  - `groupID` (string, required)
    Group ID

  - `planID` (string, required)
    Plan ID

## Query parameters:

  - `page` (integer)
    Page

  - `pageSize` (integer)
    Page Size

  - `sortBy` (string)
    Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

## Response 200 fields (text/plain):

  - `data` (array,null)

  - `data.subscriber_ID` (string, required)
    References Subscribers.Subscriber_ID value on the parent record.

  - `data.group_ID` (string, required)
    Identifier assigned to the Group associated with this Flex account. This is automatically populated by right-clicking inside of the field and selecting 'Lookup' from the context menu.

  - `data.plan_ID` (string, required)
    Unique identifier assigned to the plan. This is automatically populated by right-clicking inside of the field and selecting 'Lookup' from the context menu.

  - `data.calendar_Year` (string, required)
    Calendar year that is associated with the flex account. This is automatically populated by right-clicking inside of the field and selecting 'Lookup' from the context menu.

  - `data.effective_Date` (string, required)
    Date when the selected Flex account becomes/became active. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.auto_Create_Flex` (boolean, required)
    Indicates if this configuration would like to have flex claims auto created as part of the claims processing based on configured member responsibility amounts. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.cobrA_Rate` (number,null)
    Identifies the COBRA rate of the Flex account.

  - `data.card_Status` (string,null)
    Identifies the status of the Member's Flex account card.

  - `data.custom_Election_Info_Only` (boolean, required)
    Identifies that the Flex account information is informational only. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.election` (number,null)
    Specifies the Member's election amount toward the Flex account.

  - `data.entry_Date` (string)
    Date when the record was first added to the system.

  - `data.entry_User` (string,null)
    User that first added the record to the system.

  - `data.full_Election_For_Partial_Year` (boolean, required)
    Identifies if the amount enetered in to the Election field is a full or partial year election amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.gross_Salary` (number,null)
    Specifies the Member's gross salary for the year associated with the Flex account.

  - `data.net_Salary` (number,null)
    Specifies the Member's net salary for the year associated with the Flex account.

  - `data.purse_Status` (string,null)
    References FlexVendorPurseStatus.Purse_Status for code list.

  - `data.term_Date` (string, required)
    Date when the selected Flex account expires/expired. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.update_Date` (string)
    Date when the record was last updated in the system.

  - `data.update_User` (string,null)
    User that last updated the record in the system.

  - `error` (object)

  - `error.detail` (string,null)
    A human-readable explanation specific to this occurrence of the problem.

  - `error.instance` (string,null)
    A URI reference that identifies the specific occurrence of the problem.It may
or may not yield further information if dereferenced.

  - `error.status` (integer)
    The HTTP status code([RFC7231], Section 6) generated by the origin server for
this occurrence of the problem.

  - `error.title` (string,null)
    A short, human-readable summary of the problem type.It SHOULD NOT change from
occurrence to occurrence of the problem, except for purposes of localization(e.g.,
using proactive content negotiation; see[RFC7231], Section 3.4).

  - `error.type` (string,null)
    A URI reference [RFC3986] that identifies the problem type. This specification
encourages that, when dereferenced, it provide human-readable documentation for
the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member
is not present, its value is assumed to be "about:blank".

  - `debug` (object)

  - `debug.activityID` (string, required)


## Response 401 fields