SavingsPlansPurchaseAnalysisConfiguration

The configuration for the Savings Plans purchase analysis.

AnalysisType

The type of analysis.

Type: String

Valid Values: MAX_SAVINGS | CUSTOM_COMMITMENT

Required: Yes

LookBackTimePeriod

The time period associated with the analysis.

Type: DateInterval object

Required: Yes

SavingsPlansToAdd

Savings Plans to include in the analysis.

Type: Array of SavingsPlans objects

Array Members: Fixed number of 1 item.

Required: Yes

AccountId

The account that the analysis is for.

Type: String

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12}

Required: No

AccountScope

The account scope that you want your analysis for.

Type: String

Valid Values: PAYER | LINKED

Required: No

SavingsPlansToExclude

Savings Plans to exclude from the analysis.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 1000 items.

Length Constraints: Fixed length of 36.

Pattern: ^[\S\s]{8}-[\S\s]{4}-[\S\s]{4}-[\S\s]{4}-[\S\s]{12}$

Required: No

Contents