BenefitUtilizationSummariesRequest interface

Properties of an async benefit utilization summaries request.

Properties

benefitId

Benefit id the benefit utilization summaries report is for. Required for benefit id scope. Not supported for benefit order or any billing scopes.

benefitOrderId

Benefit order id the benefit utilization summaries report is for. Required for benefit order and benefit id scopes. Not supported for any billing scopes.

billingAccountId

Billing account the benefit utilization summaries report is for. Required for billing account and billing profile scopes. Not supported for any benefit scopes.

billingProfileId

Billing profile id the benefit utilization summaries report is for. Required for billing profile scope. Not supported for billing account or any benefit scopes.

endDate

The end date of the summaries data that will be served in the report.

grain

The grain the summaries data is served at in the report. Accepted values are 'Daily' or 'Monthly'.

kind

The type of benefit data requested. Required for billing account and billing profile scopes. Implied and not to be passed at benefit scopes. Supported values are Reservation and SavingsPlan

startDate

The start date of the summaries data that will be served in the report.

Property Details

benefitId

Benefit id the benefit utilization summaries report is for. Required for benefit id scope. Not supported for benefit order or any billing scopes.

benefitId?: string

Property Value

string

benefitOrderId

Benefit order id the benefit utilization summaries report is for. Required for benefit order and benefit id scopes. Not supported for any billing scopes.

benefitOrderId?: string

Property Value

string

billingAccountId

Billing account the benefit utilization summaries report is for. Required for billing account and billing profile scopes. Not supported for any benefit scopes.

billingAccountId?: string

Property Value

string

billingProfileId

Billing profile id the benefit utilization summaries report is for. Required for billing profile scope. Not supported for billing account or any benefit scopes.

billingProfileId?: string

Property Value

string

endDate

The end date of the summaries data that will be served in the report.

endDate: Date

Property Value

Date

grain

The grain the summaries data is served at in the report. Accepted values are 'Daily' or 'Monthly'.

grain: string

Property Value

string

kind

The type of benefit data requested. Required for billing account and billing profile scopes. Implied and not to be passed at benefit scopes. Supported values are Reservation and SavingsPlan

kind?: string

Property Value

string

startDate

The start date of the summaries data that will be served in the report.

startDate: Date

Property Value

Date