Skip to main content

Benefit

A Benefit offered to an individual in a Benefits Program

type Benefit {
  configuration: BenefitConfiguration!
  coverageLevels: [CoverageLevel!]!
  description: String!
  endDate: LocalDate
  id: ID!
  name: String!
  productCode(platformId: ID): String
  startDate: LocalDate!
  type: BenefitType!
}

Fields​

Benefit.configuration ● BenefitConfiguration! non-null object​

The configuration of the Benefit.

Benefit.coverageLevels ● [CoverageLevel!]! non-null object​

Active coverage levels configured for this offering, ordered by displayOrder.

Benefit.description ● String! non-null scalar​

A description of the Benefit

Benefit.endDate ● LocalDate scalar​

The end date of the Benefit

Benefit.id ● ID! non-null scalar​

A unique identifier for the Benefit

Benefit.name ● String! non-null scalar​

A human-readable name for the Benefit

Benefit.productCode ● String scalar​

The product code recorded for this Benefit's type on an external platform, such as the code the platform uses to identify the account type in its own systems. Null when no code is recorded for that platform. Codes are shared by every Benefit created from the same template.

Without platformId, the code on your only linked external platform is returned. If your account is linked to no platform or to more than one, platformId is required and its omission is rejected as a GraphQL error with extension code BAD_USER_INPUT, with this field resolving to null.

Benefit.productCode.platformId ● ID scalar​

The external platform whose product code to return, as an id returned by linkedExternalPlatforms. A value that is not one of your linked platform IDs is rejected as a GraphQL error with extension code BAD_USER_INPUT, and the field resolves to null. May be omitted when exactly one platform is linked to your account.

Benefit.startDate ● LocalDate! non-null scalar​

The start date of the Benefit

Benefit.type ● BenefitType! non-null enum​

The type of Benefit

Member Of​

Account object ● BenefitsProgram object ● CancelBenefitResult object ● CreateBenefitResult object ● EnrollIndividualInBenefitResult object ● TransferBenefitForIndividualResult object ● UnenrollIndividualFromBenefitResult object ● UpdateBenefitResult object

Implemented By​

BenefitResponse union