Skip to main content

ConsumerAccountSummary

A summary overview of a benefit account that a consumer has access to.

type ConsumerAccountSummary {
  active: Boolean!
  balances: ConsumerAccountSummaryBalance!
  dates: ConsumerAccountDates!
  id: ID!
  name: String!
  offeringId: ID!
  programId: ID!
  type: BenefitsOfferingAccountType!
}

Fields​

ConsumerAccountSummary.active ● Boolean! non-null scalar​

Whether or not the participant's enrollment in this offering is considered active

ConsumerAccountSummary.balances ● ConsumerAccountSummaryBalance! non-null object​

Balance information for this account.

ConsumerAccountSummary.dates ● ConsumerAccountDates! non-null object​

Date information for this account (when opened? when closed?)

ConsumerAccountSummary.id ● ID! non-null scalar​

The unique ID for this account.

ConsumerAccountSummary.name ● String! non-null scalar​

A user-displayable name for this account.

ConsumerAccountSummary.offeringId ● ID! non-null scalar​

The ID of the Offering to which this account belongs.

ConsumerAccountSummary.programId ● ID! non-null scalar​

The ID of the Program to which the Offering associated with this account belongs.

ConsumerAccountSummary.type ● BenefitsOfferingAccountType! non-null enum​

Categorizes the type of benefit this account corresponds to.

Member of​

ConsumerAccountsSummaryNode object