BillingSubscription interface

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

autoRenew?: string

Property Value

The beneficiary of the billing subscription.

beneficiary?: Beneficiary

Property Value

The provisioning tenant of the subscription.

beneficiaryTenantId?: string

Property Value

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

billingFrequency?: string

Property Value

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

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

The fully qualified ID that uniquely identifies a billing profile.

billingProfileId?: string

Property Value

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

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

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

customerDisplayName?: string

Property Value

The fully qualified ID that uniquely identifies a customer.

customerId?: string

Property Value

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

The name of the billing subscription.

displayName?: string

Property Value

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

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

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

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

The fully qualified ID that uniquely identifies an invoice section.

invoiceSectionId?: string

Property Value

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

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

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

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

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

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

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

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

Id of the product for which the subscription is purchased.

productTypeId?: string

Property Value

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

The tenant in which the subscription is provisioned.

provisioningTenantId?: string

Property Value

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

The quantity of licenses or fulfillment units for the subscription.

quantity?: number

Property Value

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

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

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

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

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

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

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

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

subscriptionId?: string

Property Value

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

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

System imposed policies that regulate behavior of the subscription.

systemOverrides?: SystemOverrides

Property Value

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

termDuration?: string

Property Value

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

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

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

Inherited From ProxyResourceWithTags.id

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

name?: string

Property Value

Inherited From ProxyResourceWithTags.name

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

Inherited From ProxyResourceWithTags.systemData

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

Inherited From ProxyResourceWithTags.tags

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

Inherited From ProxyResourceWithTags.type