BillingSubscriptionAlias interface

A billing subscription alias.

Properties

autoRenew	Indicates whether auto renewal is turned on or off for a product.
beneficiary	The beneficiary of the billing subscription.
beneficiaryTenantId	The provisioning tenant of the subscription.
billingFrequency	The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y
billingPolicies	Dictionary of billing policies associated with the subscription.
billingProfileDisplayName	The name of the billing profile.
billingProfileId	The fully qualified ID that uniquely identifies a billing profile.
billingProfileName	The ID that uniquely identifies a billing profile.
billingSubscriptionId	The ID of the billing subscription with the subscription alias.
consumptionCostCenter	The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts.
customerDisplayName	The name of the customer.
customerId	The fully qualified ID that uniquely identifies a customer.
customerName	The ID that uniquely identifies a customer.
displayName	The name of the billing subscription.
enrollmentAccountDisplayName	The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.
enrollmentAccountId	The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.
enrollmentAccountSubscriptionDetails	Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts.
invoiceSectionDisplayName	The name of the invoice section.
invoiceSectionId	The fully qualified ID that uniquely identifies an invoice section.
invoiceSectionName	The ID that uniquely identifies an invoice section.
lastMonthCharges	The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.
monthToDateCharges	The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.
nextBillingCycleDetails	Next billing cycle details of the subscription.
offerId	The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement.
operationStatus	The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details.
productCategory	The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other.
productType	Type of the product for which the subscription is purchased.
productTypeId	Id of the product for which the subscription is purchased.
provisioningState	The provisioning state of the resource during a long-running operation.
provisioningTenantId	The tenant in which the subscription is provisioned.
purchaseDate	Purchase date of the product in UTC time.
quantity	The quantity of licenses or fulfillment units for the subscription.
renewalTermDetails	Details for the next renewal term of a subscription.
reseller	Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts.
resourceUri	Unique identifier of the linked resource.
skuDescription	The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.
skuId	The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts.
status	The status of the subscription. This field is not available for Enterprise Agreement billing accounts
subscriptionId	The ID of the subscription.
suspensionReasonDetails	The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.
suspensionReasons	The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.
systemOverrides	System imposed policies that regulate behavior of the subscription.
tags	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /
termDuration	The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y
termEndDate	End date of the term in UTC time.
termStartDate	Start date of the term in UTC time.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

autoRenew

Indicates whether auto renewal is turned on or off for a product.

autoRenew?: string

Property Value

string

beneficiary

The beneficiary of the billing subscription.

beneficiary?: Beneficiary

Property Value

Beneficiary

beneficiaryTenantId

The provisioning tenant of the subscription.

beneficiaryTenantId?: string

Property Value

string

billingFrequency

The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y

billingFrequency?: string

Property Value

string

billingPolicies

Dictionary of billing policies associated with the subscription.

billingPolicies?: Record<string, string>

Property Value

Record<string, string>

billingProfileDisplayName

The name of the billing profile.

billingProfileDisplayName?: string

Property Value

string

billingProfileId

The fully qualified ID that uniquely identifies a billing profile.

billingProfileId?: string

Property Value

string

billingProfileName

The ID that uniquely identifies a billing profile.

billingProfileName?: string

Property Value

string

billingSubscriptionId

The ID of the billing subscription with the subscription alias.

billingSubscriptionId?: string

Property Value

string

consumptionCostCenter

The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts.

consumptionCostCenter?: string

Property Value

string

customerDisplayName

The name of the customer.

customerDisplayName?: string

Property Value

string

customerId

The fully qualified ID that uniquely identifies a customer.

customerId?: string

Property Value

string

customerName

The ID that uniquely identifies a customer.

customerName?: string

Property Value

string

displayName

The name of the billing subscription.

displayName?: string

Property Value

string

enrollmentAccountDisplayName

The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.

enrollmentAccountDisplayName?: string

Property Value

string

enrollmentAccountId

The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.

enrollmentAccountId?: string

Property Value

string

enrollmentAccountSubscriptionDetails

Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts.

enrollmentAccountSubscriptionDetails?: EnrollmentAccountSubscriptionDetails

Property Value

EnrollmentAccountSubscriptionDetails

invoiceSectionDisplayName

The name of the invoice section.

invoiceSectionDisplayName?: string

Property Value

string

invoiceSectionId

The fully qualified ID that uniquely identifies an invoice section.

invoiceSectionId?: string

Property Value

string

invoiceSectionName

The ID that uniquely identifies an invoice section.

invoiceSectionName?: string

Property Value

string

lastMonthCharges

The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.

lastMonthCharges?: Amount

Property Value

Amount

monthToDateCharges

The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.

monthToDateCharges?: Amount

Property Value

Amount

nextBillingCycleDetails

Next billing cycle details of the subscription.

nextBillingCycleDetails?: NextBillingCycleDetails

Property Value

NextBillingCycleDetails

offerId

The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement.

offerId?: string

Property Value

string

operationStatus

The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details.

operationStatus?: string

Property Value

string

productCategory

The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other.

productCategory?: string

Property Value

string

productType

Type of the product for which the subscription is purchased.

productType?: string

Property Value

string

productTypeId

Id of the product for which the subscription is purchased.

productTypeId?: string

Property Value

string

provisioningState

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

provisioningState?: string

Property Value

string

provisioningTenantId

The tenant in which the subscription is provisioned.

provisioningTenantId?: string

Property Value

string

purchaseDate

Purchase date of the product in UTC time.

purchaseDate?: Date

Property Value

Date

quantity

The quantity of licenses or fulfillment units for the subscription.

quantity?: number

Property Value

number

renewalTermDetails

Details for the next renewal term of a subscription.

renewalTermDetails?: RenewalTermDetails

Property Value

RenewalTermDetails

reseller

Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts.

reseller?: Reseller

Property Value

Reseller

resourceUri

Unique identifier of the linked resource.

resourceUri?: string

Property Value

string

skuDescription

The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.

skuDescription?: string

Property Value

string

skuId

The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts.

skuId?: string

Property Value

string

status

The status of the subscription. This field is not available for Enterprise Agreement billing accounts

status?: string

Property Value

string

subscriptionId

The ID of the subscription.

subscriptionId?: string

Property Value

string

suspensionReasonDetails

The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.

suspensionReasonDetails?: BillingSubscriptionStatusDetails[]

Property Value

BillingSubscriptionStatusDetails[]

suspensionReasons

The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.

suspensionReasons?: string[]

Property Value

string[]

systemOverrides

System imposed policies that regulate behavior of the subscription.

systemOverrides?: SystemOverrides

Property Value

SystemOverrides

termDuration

The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y

termDuration?: string

Property Value

string

termEndDate

End date of the term in UTC time.

termEndDate?: Date

Property Value

Date

termStartDate

Start date of the term in UTC time.

termStartDate?: Date

Property Value

Date

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type

BillingSubscriptionAlias interface

Properties

Inherited Properties

Property Details

autoRenew

Property Value

beneficiary

Property Value

beneficiaryTenantId

Property Value

billingFrequency

Property Value

billingPolicies

Property Value

billingProfileDisplayName

Property Value

billingProfileId

Property Value

billingProfileName

Property Value

billingSubscriptionId

Property Value

consumptionCostCenter

Property Value

customerDisplayName

Property Value

customerId

Property Value

customerName

Property Value

displayName

Property Value

enrollmentAccountDisplayName

Property Value

enrollmentAccountId

Property Value

enrollmentAccountSubscriptionDetails

Property Value

invoiceSectionDisplayName

Property Value

invoiceSectionId

Property Value

invoiceSectionName

Property Value

lastMonthCharges

Property Value

monthToDateCharges

Property Value

nextBillingCycleDetails

Property Value

offerId

Property Value

operationStatus

Property Value

productCategory

Property Value

productType

Property Value

productTypeId

Property Value

provisioningState

Property Value

provisioningTenantId

Property Value

purchaseDate

Property Value

quantity

Property Value

renewalTermDetails

Property Value

reseller

Property Value

resourceUri

Property Value

skuDescription

Property Value

skuId

Property Value

status

Property Value