billing_property

Creates, updates, deletes, gets or lists a billing_property resource.

Overview

Name	billing_property
Type	Resource
Id	azure.billing.billing_property

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
accountAdminNotificationEmailAddress	string	Notification email address for legacy account. Available for agreement type Microsoft Online Services Program.
billingAccountAgreementType	string	The type of agreement. Known values are: "Other", "MicrosoftCustomerAgreement", "EnterpriseAgreement", "MicrosoftOnlineServicesProgram", and "MicrosoftPartnerAgreement". (Other, MicrosoftCustomerAgreement, EnterpriseAgreement, MicrosoftOnlineServicesProgram, MicrosoftPartnerAgreement)
billingAccountDisplayName	string	The name of the billing account.
billingAccountId	string	The fully qualified ID that uniquely identifies a billing account.
billingAccountSoldToCountry	string	The country of the individual or organization that is responsible for the billing account.
billingAccountStatus	string	The current status of the billing account. Known values are: "Other", "Active", "UnderReview", "Disabled", "Deleted", "Extended", "Pending", "New", "Expired", "Terminated", and "Transferred". (Other, Active, UnderReview, Disabled, Deleted, Extended, Pending, New, Expired, Terminated, Transferred)
billingAccountStatusReasonCode	string	Reason for the specified billing account status. Known values are: "Other", "UnusualActivity", "ManuallyTerminated", "Expired", "Transferred", and "TerminateProcessing". (Other, UnusualActivity, ManuallyTerminated, Expired, Transferred, TerminateProcessing)
billingAccountSubType	string	The tier of the account. Known values are: "Other", "None", "Individual", "Professional", and "Enterprise". (Other, None, Individual, Professional, Enterprise)
billingAccountType	string	The type of customer. Known values are: "Other", "Enterprise", "Individual", "Partner", "Reseller", "ClassicPartner", "Internal", "Tenant", and "Business". (Other, Enterprise, Individual, Partner, Reseller, ClassicPartner, Internal, Tenant, Business)
billingCurrency	string	The billing currency for the subscription. Available for billing accounts with agreement type Enterprise Agreement.
billingProfileDisplayName	string	The name of the billing profile.
billingProfileId	string	The fully qualified ID that uniquely identifies a billing profile.
billingProfilePaymentMethodFamily	string	The payment method family of the primary payment method for the billing profile. Known values are: "Other", "None", "CreditCard", "Credits", "CheckWire", "EWallet", "TaskOrder", and "DirectDebit". (Other, None, CreditCard, Credits, CheckWire, EWallet, TaskOrder, DirectDebit)
billingProfilePaymentMethodType	string	The payment method type of the primary payment method for the billing profile.
billingProfileSpendingLimit	string	The billing profile spending limit. Known values are: "Off" and "On". (Off, On)
billingProfileSpendingLimitDetails	array	The details of billing profile spending limit.
billingProfileStatus	string	The status of the billing profile. Known values are: "Other", "Active", "Disabled", "Warned", "Deleted", and "UnderReview". (Other, Active, Disabled, Warned, Deleted, UnderReview)
billingProfileStatusReasonCode	string	Reason for the specified billing profile status. Known values are: "Other", "PastDue", "UnusualActivity", "SpendingLimitReached", and "SpendingLimitExpired". (Other, PastDue, UnusualActivity, SpendingLimitReached, SpendingLimitExpired)
billingTenantId	string	The Azure AD tenant ID of the billing account for the subscription.
costCenter	string	The cost center applied to the subscription. Available for agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. This property can be updated via patch.
customerDisplayName	string	The name of the customer.
customerId	string	The fully qualified ID that uniquely identifies a customer.
customerStatus	string	Identifies the status of an customer. This is an upcoming property that will be populated in the future. Known values are: "Other", "Active", "Pending", "Disabled", "Warned", "Deleted", and "UnderReview". (Other, Active, Pending, Disabled, Warned, Deleted, UnderReview)
enrollmentDetails	object	The enrollment details for the subscription. Available for billing accounts with agreement type Enterprise Agreement.
invoiceSectionDisplayName	string	The name of the invoice section.
invoiceSectionId	string	The fully qualified ID that uniquely identifies an invoice section.
invoiceSectionStatus	string	Identifies the status of an invoice section. Known values are: "Other", "Active", "Deleted", "Disabled", "UnderReview", "Warned", and "Restricted". (Other, Active, Deleted, Disabled, UnderReview, Warned, Restricted)
invoiceSectionStatusReasonCode	string	Reason for the specified invoice section status. Known values are: "Other", "PastDue", "UnusualActivity", "SpendingLimitReached", and "SpendingLimitExpired". (Other, PastDue, UnusualActivity, SpendingLimitReached, SpendingLimitExpired)
isAccountAdmin	boolean	Indicates whether user is the account admin.
isTransitionedBillingAccount	boolean	Specifies if the billing account for the subscription is transitioned from a Microsoft Online Service Program to a Microsoft Customer Agreement (MCA) account. Will be present and value will be true if its a transitioned billing account.
productId	string	The ID that uniquely identifies a product.
productName	string	The ID that uniquely identifies a product.
skuDescription	string	The sku description.
skuId	string	The ID that uniquely identifies a sku.
subscriptionBillingStatus	string	The subscription status. Known values are: "Other", "Unknown", "Active", "Disabled", "Deleted", "Warned", "Expiring", "Expired", "AutoRenew", "Cancelled", "Suspended", and "Failed". (Other, Unknown, Active, Disabled, Deleted, Warned, Expiring, Expired, AutoRenew, Cancelled, Suspended, Failed)
subscriptionBillingStatusDetails	array	The reason codes for the subscription status.
subscriptionBillingType	string	The type of billing subscription. Known values are: "None", "Benefit", "Free", "Paid", and "PrePaid". (None, Benefit, Free, Paid, PrePaid)
subscriptionServiceUsageAddress	object	The address of the individual or organization where service subscription is being used. Available for agreement type Microsoft Online Services Program. This property can be updated via patch.
subscriptionWorkloadType	string	The Azure workload type of the subscription. Known values are: "None", "Production", "DevTest", and "Internal". (None, Production, DevTest, Internal)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	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	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscription_id	includeBillingCountry, includeTransitionStatus	Gets the billing properties for a subscription.
update	update	subscription_id		Updates the billing property of a subscription. Currently, cost center can be updated for billing accounts with agreement type Microsoft Customer Agreement and subscription service usage address can be updated for billing accounts with agreement type Microsoft Online Service Program.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
subscription_id	string
includeBillingCountry	boolean	A flag that specifies whether or not to include billing country. Default value is False.
includeTransitionStatus	boolean	A flag that specifies whether or not to include transition status for billing accounts with agreement type Microsoft Customer Agreement. Default value is False.

SELECT examples

get

Gets the billing properties for a subscription.

SELECT
id,
name,
accountAdminNotificationEmailAddress,
billingAccountAgreementType,
billingAccountDisplayName,
billingAccountId,
billingAccountSoldToCountry,
billingAccountStatus,
billingAccountStatusReasonCode,
billingAccountSubType,
billingAccountType,
billingCurrency,
billingProfileDisplayName,
billingProfileId,
billingProfilePaymentMethodFamily,
billingProfilePaymentMethodType,
billingProfileSpendingLimit,
billingProfileSpendingLimitDetails,
billingProfileStatus,
billingProfileStatusReasonCode,
billingTenantId,
costCenter,
customerDisplayName,
customerId,
customerStatus,
enrollmentDetails,
invoiceSectionDisplayName,
invoiceSectionId,
invoiceSectionStatus,
invoiceSectionStatusReasonCode,
isAccountAdmin,
isTransitionedBillingAccount,
productId,
productName,
skuDescription,
skuId,
subscriptionBillingStatus,
subscriptionBillingStatusDetails,
subscriptionBillingType,
subscriptionServiceUsageAddress,
subscriptionWorkloadType,
systemData,
tags,
type
FROM azure.billing.billing_property
WHERE subscription_id = '{{ subscription_id }}' -- required
AND includeBillingCountry = '{{ includeBillingCountry }}'
AND includeTransitionStatus = '{{ includeTransitionStatus }}'
;

UPDATE examples

update

Updates the billing property of a subscription. Currently, cost center can be updated for billing accounts with agreement type Microsoft Customer Agreement and subscription service usage address can be updated for billing accounts with agreement type Microsoft Online Service Program.

UPDATE azure.billing.billing_property
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
tags,
type;