SavingsPlanModelProperties interface

Savings plan properties

Properties

appliedScopeProperties

Properties specific to applied scope type. Not required if not applicable.

appliedScopeType

Type of the Applied Scope.

benefitStartTime

This is the DateTime when the savings plan benefit starts.

billingAccountId

Fully-qualified identifier of the billing account where the savings plan is applied.

billingPlan

Represents the billing plan in ISO 8601 format. Required only for monthly purchases.

billingProfileId

Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers.

billingScopeId

Subscription that will be charged for purchasing SavingsPlan

commitment

Commitment towards the benefit.

customerId

Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers.

displayName

Display name

displayProvisioningState

The provisioning state of the savings plan for display, e.g. Succeeded

effectiveDateTime

DateTime of the savings plan starting when this version is effective from.

expiryDateTime

This is the date-time when the savings plan will expire.

extendedStatusInfo

Extended status information

productCode

Represents UPN

provisioningState

The provisioning state of the resource during a long-running operation.

purchaseDateTime

Date time when the savings plan was purchased.

renew

Setting this to true will automatically purchase a new benefit on the expiration date time.

renewDestination

SavingsPlan Id of the SavingsPlan which is purchased because of renew.

renewProperties

Properties specific to renew.

renewSource

SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed.

term

Represents the Savings plan term in ISO 8601 format.

userFriendlyAppliedScopeType

The applied scope type of the savings plan for display, e.g. Shared

utilization

Savings plan utilization

Property Details

appliedScopeProperties

Properties specific to applied scope type. Not required if not applicable.

appliedScopeProperties?: AppliedScopeProperties

Property Value

appliedScopeType

Type of the Applied Scope.

appliedScopeType?: string

Property Value

string

benefitStartTime

This is the DateTime when the savings plan benefit starts.

benefitStartTime?: Date

Property Value

Date

billingAccountId

Fully-qualified identifier of the billing account where the savings plan is applied.

billingAccountId?: string

Property Value

string

billingPlan

Represents the billing plan in ISO 8601 format. Required only for monthly purchases.

billingPlan?: string

Property Value

string

billingProfileId

Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers.

billingProfileId?: string

Property Value

string

billingScopeId

Subscription that will be charged for purchasing SavingsPlan

billingScopeId?: string

Property Value

string

commitment

Commitment towards the benefit.

commitment?: Commitment

Property Value

customerId

Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers.

customerId?: string

Property Value

string

displayName

Display name

displayName?: string

Property Value

string

displayProvisioningState

The provisioning state of the savings plan for display, e.g. Succeeded

displayProvisioningState?: string

Property Value

string

effectiveDateTime

DateTime of the savings plan starting when this version is effective from.

effectiveDateTime?: Date

Property Value

Date

expiryDateTime

This is the date-time when the savings plan will expire.

expiryDateTime?: Date

Property Value

Date

extendedStatusInfo

Extended status information

extendedStatusInfo?: ExtendedStatusInfo

Property Value

productCode

Represents UPN

productCode?: string

Property Value

string

provisioningState

The provisioning state of the resource during a long-running operation.

provisioningState?: string

Property Value

string

purchaseDateTime

Date time when the savings plan was purchased.

purchaseDateTime?: Date

Property Value

Date

renew

Setting this to true will automatically purchase a new benefit on the expiration date time.

renew?: boolean

Property Value

boolean

renewDestination

SavingsPlan Id of the SavingsPlan which is purchased because of renew.

renewDestination?: string

Property Value

string

renewProperties

Properties specific to renew.

renewProperties?: RenewProperties

Property Value

renewSource

SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed.

renewSource?: string

Property Value

string

term

Represents the Savings plan term in ISO 8601 format.

term?: string

Property Value

string

userFriendlyAppliedScopeType

The applied scope type of the savings plan for display, e.g. Shared

userFriendlyAppliedScopeType?: string

Property Value

string

utilization

Savings plan utilization

utilization?: Utilization

Property Value