BillingSubscription interface

Package:

@azure/arm-billing

The billing properties of a subscription.

Extends

ProxyResourceWithTags

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.

Inherited Properties

id	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
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 < > % & \ ? /
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

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

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

Property Value

{[propertyName: string]: string}

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

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

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

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

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

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

enrollmentAccountId?: string

Property Value

string

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

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

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

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

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

monthToDateCharges?: Amount

Property Value

Amount

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

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

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

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

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

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

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

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

renewalTermDetails?: RenewalTermDetails

Property Value

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

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

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

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

status?: string

Property Value

string

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

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

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[]

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[]

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

termEndDate?: Date

Property Value

Date

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 Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResourceWithTags.id

name

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

name?: string

Property Value

string

Inherited From ProxyResourceWithTags.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResourceWithTags.systemData

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 < > % & \ ? /

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

Property Value

{[propertyName: string]: string}

Inherited From ProxyResourceWithTags.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResourceWithTags.type