Skip to main content

BenefitsOfferingGracePeriodConfiguration

Describes the availability and state of the Grace Period feature for a Benefits Offering. Grace Period enables claims/card spend to be incurred for a period of time after the Offering end.

type BenefitsOfferingGracePeriodConfiguration {
  available: Boolean!
  enabled: Boolean!
  gracePeriodEndDate: DateString
  gracePeriodInDays: Int
  id: ID!
  mutuallyExclusiveWith: [ConfigurableBenefitsOfferingFeature!]
  validationRules: BenefitsOfferingGracePeriodValidationConfiguration
}

Fields​

BenefitsOfferingGracePeriodConfiguration.available ● Boolean! non-null scalar​

If true, Grace Period is available for this Offering type. This is a read-only attribute. If false, enabled must be false and all attributes MUST BE unsettable.

BenefitsOfferingGracePeriodConfiguration.enabled ● Boolean! non-null scalar​

If true, Grace Period is enabled for this Offering.

BenefitsOfferingGracePeriodConfiguration.gracePeriodEndDate ● DateString scalar​

The date (YYYY-MM-DD) the Grace Period ends. If absent, enabled MUST be false. If present, enabled MUST be true.

BenefitsOfferingGracePeriodConfiguration.gracePeriodInDays ● Int scalar​

The configured Grace Period in days. If absent, enabled MUST be false. If present, enabled MUST be true.

BenefitsOfferingGracePeriodConfiguration.id ● ID! non-null scalar​

The ID of this configurable feature.

BenefitsOfferingGracePeriodConfiguration.mutuallyExclusiveWith ● [ConfigurableBenefitsOfferingFeature!] list enum​

If present, this feature is mutually exclusive with all features defined here. Client can configure this feature, or one or more of the features in this definition, but this feature cannot be configured if any features in this definition are configured. Client should use this for UI/X controls.

BenefitsOfferingGracePeriodConfiguration.validationRules ● BenefitsOfferingGracePeriodValidationConfiguration object​

Validation rules governing the Grace Period feature. Present only if the feature is available.

Member of​

BenefitsOfferingConfiguration object