Share via

BillingSubscriptionAliasProperties interface

  • Reference
Package:
@azure/arm-billing

A billing subscription alias.

Extends
BillingSubscriptionProperties

Properties

billingSubscriptionId

The ID of the billing subscription with the subscription alias. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited 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. NOTE: This property will not be serialized. It can only be populated by the server.
billingProfileDisplayName

The name of the billing profile. NOTE: This property will not be serialized. It can only be populated by the server.
billingProfileId

The fully qualified ID that uniquely identifies a billing profile.
billingProfileName

The ID that uniquely identifies a billing profile. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
customerId

The fully qualified ID that uniquely identifies a customer.
customerName

The ID that uniquely identifies a customer. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
enrollmentAccountId

The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. NOTE: This property will not be serialized. It can only be populated by the server.
enrollmentAccountStartDate

The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. NOTE: This property will not be serialized. It can only be populated by the server.
invoiceSectionDisplayName

The name of the invoice section. NOTE: This property will not be serialized. It can only be populated by the server.
invoiceSectionId

The fully qualified ID that uniquely identifies an invoice section.
invoiceSectionName

The ID that uniquely identifies an invoice section. NOTE: This property will not be serialized. It can only be populated by the server.
lastMonthCharges

The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. NOTE: This property will not be serialized. It can only be populated by the server.
monthToDateCharges

The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. NOTE: This property will not be serialized. It can only be populated by the server.
nextBillingCycleDetails

Next billing cycle details of the subscription. NOTE: This property will not be serialized. It can only be populated by the server.
offerId

The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
productCategory

The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. NOTE: This property will not be serialized. It can only be populated by the server.
productType

Type of the product for which the subscription is purchased. NOTE: This property will not be serialized. It can only be populated by the server.
productTypeId

Id of the product for which the subscription is purchased.
provisioningState

The provisioning state of the resource during a long-running operation. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningTenantId

The tenant in which the subscription is provisioned.
purchaseDate

Purchase date of the product in UTC time. NOTE: This property will not be serialized. It can only be populated by the server.
quantity

The quantity of licenses or fulfillment units for the subscription.
renewalTermDetails

Details for the next renewal term of a subscription. NOTE: This property will not be serialized. It can only be populated by the server.
reseller

Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. NOTE: This property will not be serialized. It can only be populated by the server.
resourceUri

Unique identifier of the linked resource. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
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 NOTE: This property will not be serialized. It can only be populated by the server.
subscriptionEnrollmentAccountStatus

The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. NOTE: This property will not be serialized. It can only be populated by the server.
subscriptionId

The ID of the subscription. NOTE: This property will not be serialized. It can only be populated by the server.
suspensionReasonDetails

The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. NOTE: This property will not be serialized. It can only be populated by the server.
suspensionReasons

The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. NOTE: This property will not be serialized. It can only be populated by the server.
systemOverrides

System imposed policies that regulate behavior of the subscription.
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. NOTE: This property will not be serialized. It can only be populated by the server.
termStartDate

Start date of the term in UTC time. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

billingSubscriptionId

The ID of the billing subscription with the subscription alias. NOTE: This property will not be serialized. It can only be populated by the server.

billingSubscriptionId?: string

Property Value

string

Inherited Property Details

autoRenew

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

autoRenew?: string

Property Value

string

Inherited From BillingSubscriptionProperties.autoRenew

beneficiary

The beneficiary of the billing subscription.

beneficiary?: Beneficiary

Property Value

Beneficiary

Inherited From BillingSubscriptionProperties.beneficiary

beneficiaryTenantId

The provisioning tenant of the subscription.

beneficiaryTenantId?: string

Property Value

string

Inherited From BillingSubscriptionProperties.beneficiaryTenantId

billingFrequency

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

billingFrequency?: string

Property Value

string

Inherited From BillingSubscriptionProperties.billingFrequency

billingPolicies

Dictionary of billing policies associated with the subscription. NOTE: This property will not be serialized. It can only be populated by the server.

billingPolicies?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From BillingSubscriptionProperties.billingPolicies

billingProfileDisplayName

The name of the billing profile. NOTE: This property will not be serialized. It can only be populated by the server.

billingProfileDisplayName?: string

Property Value

string

Inherited From BillingSubscriptionProperties.billingProfileDisplayName

billingProfileId

The fully qualified ID that uniquely identifies a billing profile.

billingProfileId?: string

Property Value

string

Inherited From BillingSubscriptionProperties.billingProfileId

billingProfileName

The ID that uniquely identifies a billing profile. NOTE: This property will not be serialized. It can only be populated by the server.

billingProfileName?: string

Property Value

string

Inherited From BillingSubscriptionProperties.billingProfileName

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

Inherited From BillingSubscriptionProperties.consumptionCostCenter

customerDisplayName

The name of the customer. NOTE: This property will not be serialized. It can only be populated by the server.

customerDisplayName?: string

Property Value

string

Inherited From BillingSubscriptionProperties.customerDisplayName

customerId

The fully qualified ID that uniquely identifies a customer.

customerId?: string

Property Value

string

Inherited From BillingSubscriptionProperties.customerId

customerName

The ID that uniquely identifies a customer. NOTE: This property will not be serialized. It can only be populated by the server.

customerName?: string

Property Value

string

Inherited From BillingSubscriptionProperties.customerName

displayName

The name of the billing subscription.

displayName?: string

Property Value

string

Inherited From BillingSubscriptionProperties.displayName

enrollmentAccountDisplayName

The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. NOTE: This property will not be serialized. It can only be populated by the server.

enrollmentAccountDisplayName?: string

Property Value

string

Inherited From BillingSubscriptionProperties.enrollmentAccountDisplayName

enrollmentAccountId

The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. NOTE: This property will not be serialized. It can only be populated by the server.

enrollmentAccountId?: string

Property Value

string

Inherited From BillingSubscriptionProperties.enrollmentAccountId

enrollmentAccountStartDate

The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. NOTE: This property will not be serialized. It can only be populated by the server.

enrollmentAccountStartDate?: Date

Property Value

Date

Inherited From BillingSubscriptionProperties.enrollmentAccountStartDate

invoiceSectionDisplayName

The name of the invoice section. NOTE: This property will not be serialized. It can only be populated by the server.

invoiceSectionDisplayName?: string

Property Value

string

Inherited From BillingSubscriptionProperties.invoiceSectionDisplayName

invoiceSectionId

The fully qualified ID that uniquely identifies an invoice section.

invoiceSectionId?: string

Property Value

string

Inherited From BillingSubscriptionProperties.invoiceSectionId

invoiceSectionName

The ID that uniquely identifies an invoice section. NOTE: This property will not be serialized. It can only be populated by the server.

invoiceSectionName?: string

Property Value

string

Inherited From BillingSubscriptionProperties.invoiceSectionName

lastMonthCharges

The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. NOTE: This property will not be serialized. It can only be populated by the server.

lastMonthCharges?: Amount

Property Value

Amount

Inherited From BillingSubscriptionProperties.lastMonthCharges

monthToDateCharges

The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. NOTE: This property will not be serialized. It can only be populated by the server.

monthToDateCharges?: Amount

Property Value

Amount

Inherited From BillingSubscriptionProperties.monthToDateCharges

nextBillingCycleDetails

Next billing cycle details of the subscription. NOTE: This property will not be serialized. It can only be populated by the server.

nextBillingCycleDetails?: NextBillingCycleDetails

Property Value

NextBillingCycleDetails

Inherited From BillingSubscriptionProperties.nextBillingCycleDetails

offerId

The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts. NOTE: This property will not be serialized. It can only be populated by the server.

offerId?: string

Property Value

string

Inherited From BillingSubscriptionProperties.offerId

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. NOTE: This property will not be serialized. It can only be populated by the server.

operationStatus?: string

Property Value

string

Inherited From BillingSubscriptionProperties.operationStatus

productCategory

The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. NOTE: This property will not be serialized. It can only be populated by the server.

productCategory?: string

Property Value

string

Inherited From BillingSubscriptionProperties.productCategory

productType

Type of the product for which the subscription is purchased. NOTE: This property will not be serialized. It can only be populated by the server.

productType?: string

Property Value

string

Inherited From BillingSubscriptionProperties.productType

productTypeId

Id of the product for which the subscription is purchased.

productTypeId?: string

Property Value

string

Inherited From BillingSubscriptionProperties.productTypeId

provisioningState

The provisioning state of the resource during a long-running operation. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

Inherited From BillingSubscriptionProperties.provisioningState

provisioningTenantId

The tenant in which the subscription is provisioned.

provisioningTenantId?: string

Property Value

string

Inherited From BillingSubscriptionProperties.provisioningTenantId

purchaseDate

Purchase date of the product in UTC time. NOTE: This property will not be serialized. It can only be populated by the server.

purchaseDate?: Date

Property Value

Date

Inherited From BillingSubscriptionProperties.purchaseDate

quantity

The quantity of licenses or fulfillment units for the subscription.

quantity?: number

Property Value

number

Inherited From BillingSubscriptionProperties.quantity

renewalTermDetails

Details for the next renewal term of a subscription. NOTE: This property will not be serialized. It can only be populated by the server.

renewalTermDetails?: RenewalTermDetails

Property Value

RenewalTermDetails

Inherited From BillingSubscriptionProperties.renewalTermDetails

reseller

Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. NOTE: This property will not be serialized. It can only be populated by the server.

reseller?: Reseller

Property Value

Reseller

Inherited From BillingSubscriptionProperties.reseller

resourceUri

Unique identifier of the linked resource. NOTE: This property will not be serialized. It can only be populated by the server.

resourceUri?: string

Property Value

string

Inherited From BillingSubscriptionProperties.resourceUri

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. NOTE: This property will not be serialized. It can only be populated by the server.

skuDescription?: string

Property Value

string

Inherited From BillingSubscriptionProperties.skuDescription

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

Inherited From BillingSubscriptionProperties.skuId

status

The status of the subscription. This field is not available for Enterprise Agreement billing accounts NOTE: This property will not be serialized. It can only be populated by the server.

status?: string

Property Value

string

Inherited From BillingSubscriptionProperties.status

subscriptionEnrollmentAccountStatus

The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. NOTE: This property will not be serialized. It can only be populated by the server.

subscriptionEnrollmentAccountStatus?: string

Property Value

string

Inherited From BillingSubscriptionProperties.subscriptionEnrollmentAccountStatus

subscriptionId

The ID of the subscription. NOTE: This property will not be serialized. It can only be populated by the server.

subscriptionId?: string

Property Value

string

Inherited From BillingSubscriptionProperties.subscriptionId

suspensionReasonDetails

The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. NOTE: This property will not be serialized. It can only be populated by the server.

suspensionReasonDetails?: BillingSubscriptionStatusDetails[]

Property Value

BillingSubscriptionStatusDetails[]

Inherited From BillingSubscriptionProperties.suspensionReasonDetails

suspensionReasons

The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. NOTE: This property will not be serialized. It can only be populated by the server.

suspensionReasons?: string[]

Property Value

string[]

Inherited From BillingSubscriptionProperties.suspensionReasons

systemOverrides

System imposed policies that regulate behavior of the subscription.

systemOverrides?: SystemOverrides

Property Value

SystemOverrides

Inherited From BillingSubscriptionProperties.systemOverrides

termDuration

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

termDuration?: string

Property Value

string

Inherited From BillingSubscriptionProperties.termDuration

termEndDate

End date of the term in UTC time. NOTE: This property will not be serialized. It can only be populated by the server.

termEndDate?: Date

Property Value

Date

Inherited From BillingSubscriptionProperties.termEndDate

termStartDate

Start date of the term in UTC time. NOTE: This property will not be serialized. It can only be populated by the server.

termStartDate?: Date

Property Value

Date

Inherited From BillingSubscriptionProperties.termStartDate