billing_subscriptions

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

Overview

Name	billing_subscriptions
Type	Resource
Id	azure.billing.billing_subscriptions

Fields

The following fields are returned by SELECT queries:

list_by_customer

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.
autoRenew	string	Indicates whether auto renewal is turned on or off for a product. Known values are: "Off" and "On". (Off, On)
beneficiary	object	The beneficiary of the billing subscription.
beneficiaryTenantId	string	The provisioning tenant of the subscription.
billingFrequency	string	The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y.
billingPolicies	object	Dictionary of billing policies associated with the subscription.
billingProfileDisplayName	string	The name of the billing profile.
billingProfileId	string	The fully qualified ID that uniquely identifies a billing profile.
billingProfileName	string	The ID that uniquely identifies a billing profile.
consumptionCostCenter	string	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	string	The name of the customer.
customerId	string	The fully qualified ID that uniquely identifies a customer.
customerName	string	The ID that uniquely identifies a customer.
displayName	string	The name of the billing subscription.
enrollmentAccountDisplayName	string	The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.
enrollmentAccountId	string	The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.
enrollmentAccountSubscriptionDetails	object	Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts.
invoiceSectionDisplayName	string	The name of the invoice section.
invoiceSectionId	string	The fully qualified ID that uniquely identifies an invoice section.
invoiceSectionName	string	The ID that uniquely identifies an invoice section.
lastMonthCharges	object	The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.
monthToDateCharges	object	The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.
nextBillingCycleDetails	object	Next billing cycle details of the subscription.
offerId	string	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	string	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. Known values are: "Other", "None", and "LockedForUpdate". (Other, None, LockedForUpdate)
productCategory	string	The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other.
productType	string	Type of the product for which the subscription is purchased.
productTypeId	string	Id of the product for which the subscription is purchased.
provisioningState	string	The provisioning state of the resource during a long-running operation. Known values are: "Succeeded", "Canceled", "Failed", "New", "Pending", "Provisioning", "PendingBilling", "ConfirmedBilling", "Creating", "Created", and "Expired". (Succeeded, Canceled, Failed, New, Pending, Provisioning, PendingBilling, ConfirmedBilling, Creating, Created, Expired)
provisioningTenantId	string	The tenant in which the subscription is provisioned.
purchaseDate	string (date-time)	Purchase date of the product in UTC time.
quantity	integer	The quantity of licenses or fulfillment units for the subscription.
renewalTermDetails	object	Details for the next renewal term of a subscription.
reseller	object	Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts.
resourceUri	string	Unique identifier of the linked resource.
skuDescription	string	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	string	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	string	The status of the subscription. This field is not available for Enterprise Agreement billing accounts. 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)
subscriptionId	string	The ID of the subscription.
suspensionReasonDetails	array	The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.
suspensionReasons	array	The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemOverrides	object	System imposed policies that regulate behavior of the subscription.
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 < > % & \ ? /.
termDuration	string	The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y.
termEndDate	string (date-time)	End date of the term in UTC time.
termStartDate	string (date-time)	Start date of the term in UTC time.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_invoice_section

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.
autoRenew	string	Indicates whether auto renewal is turned on or off for a product. Known values are: "Off" and "On". (Off, On)
beneficiary	object	The beneficiary of the billing subscription.
beneficiaryTenantId	string	The provisioning tenant of the subscription.
billingFrequency	string	The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y.
billingPolicies	object	Dictionary of billing policies associated with the subscription.
billingProfileDisplayName	string	The name of the billing profile.
billingProfileId	string	The fully qualified ID that uniquely identifies a billing profile.
billingProfileName	string	The ID that uniquely identifies a billing profile.
consumptionCostCenter	string	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	string	The name of the customer.
customerId	string	The fully qualified ID that uniquely identifies a customer.
customerName	string	The ID that uniquely identifies a customer.
displayName	string	The name of the billing subscription.
enrollmentAccountDisplayName	string	The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.
enrollmentAccountId	string	The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.
enrollmentAccountSubscriptionDetails	object	Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts.
invoiceSectionDisplayName	string	The name of the invoice section.
invoiceSectionId	string	The fully qualified ID that uniquely identifies an invoice section.
invoiceSectionName	string	The ID that uniquely identifies an invoice section.
lastMonthCharges	object	The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.
monthToDateCharges	object	The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.
nextBillingCycleDetails	object	Next billing cycle details of the subscription.
offerId	string	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	string	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. Known values are: "Other", "None", and "LockedForUpdate". (Other, None, LockedForUpdate)
productCategory	string	The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other.
productType	string	Type of the product for which the subscription is purchased.
productTypeId	string	Id of the product for which the subscription is purchased.
provisioningState	string	The provisioning state of the resource during a long-running operation. Known values are: "Succeeded", "Canceled", "Failed", "New", "Pending", "Provisioning", "PendingBilling", "ConfirmedBilling", "Creating", "Created", and "Expired". (Succeeded, Canceled, Failed, New, Pending, Provisioning, PendingBilling, ConfirmedBilling, Creating, Created, Expired)
provisioningTenantId	string	The tenant in which the subscription is provisioned.
purchaseDate	string (date-time)	Purchase date of the product in UTC time.
quantity	integer	The quantity of licenses or fulfillment units for the subscription.
renewalTermDetails	object	Details for the next renewal term of a subscription.
reseller	object	Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts.
resourceUri	string	Unique identifier of the linked resource.
skuDescription	string	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	string	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	string	The status of the subscription. This field is not available for Enterprise Agreement billing accounts. 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)
subscriptionId	string	The ID of the subscription.
suspensionReasonDetails	array	The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.
suspensionReasons	array	The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemOverrides	object	System imposed policies that regulate behavior of the subscription.
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 < > % & \ ? /.
termDuration	string	The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y.
termEndDate	string (date-time)	End date of the term in UTC time.
termStartDate	string (date-time)	Start date of the term in UTC time.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_by_billing_profile

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.
autoRenew	string	Indicates whether auto renewal is turned on or off for a product. Known values are: "Off" and "On". (Off, On)
beneficiary	object	The beneficiary of the billing subscription.
beneficiaryTenantId	string	The provisioning tenant of the subscription.
billingFrequency	string	The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y.
billingPolicies	object	Dictionary of billing policies associated with the subscription.
billingProfileDisplayName	string	The name of the billing profile.
billingProfileId	string	The fully qualified ID that uniquely identifies a billing profile.
billingProfileName	string	The ID that uniquely identifies a billing profile.
consumptionCostCenter	string	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	string	The name of the customer.
customerId	string	The fully qualified ID that uniquely identifies a customer.
customerName	string	The ID that uniquely identifies a customer.
displayName	string	The name of the billing subscription.
enrollmentAccountDisplayName	string	The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.
enrollmentAccountId	string	The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.
enrollmentAccountSubscriptionDetails	object	Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts.
invoiceSectionDisplayName	string	The name of the invoice section.
invoiceSectionId	string	The fully qualified ID that uniquely identifies an invoice section.
invoiceSectionName	string	The ID that uniquely identifies an invoice section.
lastMonthCharges	object	The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.
monthToDateCharges	object	The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.
nextBillingCycleDetails	object	Next billing cycle details of the subscription.
offerId	string	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	string	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. Known values are: "Other", "None", and "LockedForUpdate". (Other, None, LockedForUpdate)
productCategory	string	The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other.
productType	string	Type of the product for which the subscription is purchased.
productTypeId	string	Id of the product for which the subscription is purchased.
provisioningState	string	The provisioning state of the resource during a long-running operation. Known values are: "Succeeded", "Canceled", "Failed", "New", "Pending", "Provisioning", "PendingBilling", "ConfirmedBilling", "Creating", "Created", and "Expired". (Succeeded, Canceled, Failed, New, Pending, Provisioning, PendingBilling, ConfirmedBilling, Creating, Created, Expired)
provisioningTenantId	string	The tenant in which the subscription is provisioned.
purchaseDate	string (date-time)	Purchase date of the product in UTC time.
quantity	integer	The quantity of licenses or fulfillment units for the subscription.
renewalTermDetails	object	Details for the next renewal term of a subscription.
reseller	object	Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts.
resourceUri	string	Unique identifier of the linked resource.
skuDescription	string	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	string	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	string	The status of the subscription. This field is not available for Enterprise Agreement billing accounts. 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)
subscriptionId	string	The ID of the subscription.
suspensionReasonDetails	array	The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.
suspensionReasons	array	The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemOverrides	object	System imposed policies that regulate behavior of the subscription.
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 < > % & \ ? /.
termDuration	string	The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y.
termEndDate	string (date-time)	End date of the term in UTC time.
termStartDate	string (date-time)	Start date of the term in UTC time.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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.
autoRenew	string	Indicates whether auto renewal is turned on or off for a product. Known values are: "Off" and "On". (Off, On)
beneficiary	object	The beneficiary of the billing subscription.
beneficiaryTenantId	string	The provisioning tenant of the subscription.
billingFrequency	string	The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y.
billingPolicies	object	Dictionary of billing policies associated with the subscription.
billingProfileDisplayName	string	The name of the billing profile.
billingProfileId	string	The fully qualified ID that uniquely identifies a billing profile.
billingProfileName	string	The ID that uniquely identifies a billing profile.
consumptionCostCenter	string	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	string	The name of the customer.
customerId	string	The fully qualified ID that uniquely identifies a customer.
customerName	string	The ID that uniquely identifies a customer.
displayName	string	The name of the billing subscription.
enrollmentAccountDisplayName	string	The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.
enrollmentAccountId	string	The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.
enrollmentAccountSubscriptionDetails	object	Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts.
invoiceSectionDisplayName	string	The name of the invoice section.
invoiceSectionId	string	The fully qualified ID that uniquely identifies an invoice section.
invoiceSectionName	string	The ID that uniquely identifies an invoice section.
lastMonthCharges	object	The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.
monthToDateCharges	object	The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.
nextBillingCycleDetails	object	Next billing cycle details of the subscription.
offerId	string	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	string	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. Known values are: "Other", "None", and "LockedForUpdate". (Other, None, LockedForUpdate)
productCategory	string	The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other.
productType	string	Type of the product for which the subscription is purchased.
productTypeId	string	Id of the product for which the subscription is purchased.
provisioningState	string	The provisioning state of the resource during a long-running operation. Known values are: "Succeeded", "Canceled", "Failed", "New", "Pending", "Provisioning", "PendingBilling", "ConfirmedBilling", "Creating", "Created", and "Expired". (Succeeded, Canceled, Failed, New, Pending, Provisioning, PendingBilling, ConfirmedBilling, Creating, Created, Expired)
provisioningTenantId	string	The tenant in which the subscription is provisioned.
purchaseDate	string (date-time)	Purchase date of the product in UTC time.
quantity	integer	The quantity of licenses or fulfillment units for the subscription.
renewalTermDetails	object	Details for the next renewal term of a subscription.
reseller	object	Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts.
resourceUri	string	Unique identifier of the linked resource.
skuDescription	string	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	string	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	string	The status of the subscription. This field is not available for Enterprise Agreement billing accounts. 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)
subscriptionId	string	The ID of the subscription.
suspensionReasonDetails	array	The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.
suspensionReasons	array	The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemOverrides	object	System imposed policies that regulate behavior of the subscription.
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 < > % & \ ? /.
termDuration	string	The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y.
termEndDate	string (date-time)	End date of the term in UTC time.
termStartDate	string (date-time)	Start date of the term in UTC time.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_billing_profile

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.
autoRenew	string	Indicates whether auto renewal is turned on or off for a product. Known values are: "Off" and "On". (Off, On)
beneficiary	object	The beneficiary of the billing subscription.
beneficiaryTenantId	string	The provisioning tenant of the subscription.
billingFrequency	string	The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y.
billingPolicies	object	Dictionary of billing policies associated with the subscription.
billingProfileDisplayName	string	The name of the billing profile.
billingProfileId	string	The fully qualified ID that uniquely identifies a billing profile.
billingProfileName	string	The ID that uniquely identifies a billing profile.
consumptionCostCenter	string	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	string	The name of the customer.
customerId	string	The fully qualified ID that uniquely identifies a customer.
customerName	string	The ID that uniquely identifies a customer.
displayName	string	The name of the billing subscription.
enrollmentAccountDisplayName	string	The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.
enrollmentAccountId	string	The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.
enrollmentAccountSubscriptionDetails	object	Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts.
invoiceSectionDisplayName	string	The name of the invoice section.
invoiceSectionId	string	The fully qualified ID that uniquely identifies an invoice section.
invoiceSectionName	string	The ID that uniquely identifies an invoice section.
lastMonthCharges	object	The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.
monthToDateCharges	object	The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.
nextBillingCycleDetails	object	Next billing cycle details of the subscription.
offerId	string	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	string	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. Known values are: "Other", "None", and "LockedForUpdate". (Other, None, LockedForUpdate)
productCategory	string	The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other.
productType	string	Type of the product for which the subscription is purchased.
productTypeId	string	Id of the product for which the subscription is purchased.
provisioningState	string	The provisioning state of the resource during a long-running operation. Known values are: "Succeeded", "Canceled", "Failed", "New", "Pending", "Provisioning", "PendingBilling", "ConfirmedBilling", "Creating", "Created", and "Expired". (Succeeded, Canceled, Failed, New, Pending, Provisioning, PendingBilling, ConfirmedBilling, Creating, Created, Expired)
provisioningTenantId	string	The tenant in which the subscription is provisioned.
purchaseDate	string (date-time)	Purchase date of the product in UTC time.
quantity	integer	The quantity of licenses or fulfillment units for the subscription.
renewalTermDetails	object	Details for the next renewal term of a subscription.
reseller	object	Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts.
resourceUri	string	Unique identifier of the linked resource.
skuDescription	string	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	string	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	string	The status of the subscription. This field is not available for Enterprise Agreement billing accounts. 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)
subscriptionId	string	The ID of the subscription.
suspensionReasonDetails	array	The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.
suspensionReasons	array	The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemOverrides	object	System imposed policies that regulate behavior of the subscription.
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 < > % & \ ? /.
termDuration	string	The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y.
termEndDate	string (date-time)	End date of the term in UTC time.
termStartDate	string (date-time)	Start date of the term in UTC time.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_customer_at_billing_account

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.
autoRenew	string	Indicates whether auto renewal is turned on or off for a product. Known values are: "Off" and "On". (Off, On)
beneficiary	object	The beneficiary of the billing subscription.
beneficiaryTenantId	string	The provisioning tenant of the subscription.
billingFrequency	string	The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y.
billingPolicies	object	Dictionary of billing policies associated with the subscription.
billingProfileDisplayName	string	The name of the billing profile.
billingProfileId	string	The fully qualified ID that uniquely identifies a billing profile.
billingProfileName	string	The ID that uniquely identifies a billing profile.
consumptionCostCenter	string	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	string	The name of the customer.
customerId	string	The fully qualified ID that uniquely identifies a customer.
customerName	string	The ID that uniquely identifies a customer.
displayName	string	The name of the billing subscription.
enrollmentAccountDisplayName	string	The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.
enrollmentAccountId	string	The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.
enrollmentAccountSubscriptionDetails	object	Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts.
invoiceSectionDisplayName	string	The name of the invoice section.
invoiceSectionId	string	The fully qualified ID that uniquely identifies an invoice section.
invoiceSectionName	string	The ID that uniquely identifies an invoice section.
lastMonthCharges	object	The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.
monthToDateCharges	object	The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.
nextBillingCycleDetails	object	Next billing cycle details of the subscription.
offerId	string	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	string	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. Known values are: "Other", "None", and "LockedForUpdate". (Other, None, LockedForUpdate)
productCategory	string	The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other.
productType	string	Type of the product for which the subscription is purchased.
productTypeId	string	Id of the product for which the subscription is purchased.
provisioningState	string	The provisioning state of the resource during a long-running operation. Known values are: "Succeeded", "Canceled", "Failed", "New", "Pending", "Provisioning", "PendingBilling", "ConfirmedBilling", "Creating", "Created", and "Expired". (Succeeded, Canceled, Failed, New, Pending, Provisioning, PendingBilling, ConfirmedBilling, Creating, Created, Expired)
provisioningTenantId	string	The tenant in which the subscription is provisioned.
purchaseDate	string (date-time)	Purchase date of the product in UTC time.
quantity	integer	The quantity of licenses or fulfillment units for the subscription.
renewalTermDetails	object	Details for the next renewal term of a subscription.
reseller	object	Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts.
resourceUri	string	Unique identifier of the linked resource.
skuDescription	string	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	string	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	string	The status of the subscription. This field is not available for Enterprise Agreement billing accounts. 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)
subscriptionId	string	The ID of the subscription.
suspensionReasonDetails	array	The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.
suspensionReasons	array	The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemOverrides	object	System imposed policies that regulate behavior of the subscription.
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 < > % & \ ? /.
termDuration	string	The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y.
termEndDate	string (date-time)	End date of the term in UTC time.
termStartDate	string (date-time)	Start date of the term in UTC time.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_enrollment_account

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.
autoRenew	string	Indicates whether auto renewal is turned on or off for a product. Known values are: "Off" and "On". (Off, On)
beneficiary	object	The beneficiary of the billing subscription.
beneficiaryTenantId	string	The provisioning tenant of the subscription.
billingFrequency	string	The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y.
billingPolicies	object	Dictionary of billing policies associated with the subscription.
billingProfileDisplayName	string	The name of the billing profile.
billingProfileId	string	The fully qualified ID that uniquely identifies a billing profile.
billingProfileName	string	The ID that uniquely identifies a billing profile.
consumptionCostCenter	string	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	string	The name of the customer.
customerId	string	The fully qualified ID that uniquely identifies a customer.
customerName	string	The ID that uniquely identifies a customer.
displayName	string	The name of the billing subscription.
enrollmentAccountDisplayName	string	The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.
enrollmentAccountId	string	The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.
enrollmentAccountSubscriptionDetails	object	Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts.
invoiceSectionDisplayName	string	The name of the invoice section.
invoiceSectionId	string	The fully qualified ID that uniquely identifies an invoice section.
invoiceSectionName	string	The ID that uniquely identifies an invoice section.
lastMonthCharges	object	The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.
monthToDateCharges	object	The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.
nextBillingCycleDetails	object	Next billing cycle details of the subscription.
offerId	string	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	string	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. Known values are: "Other", "None", and "LockedForUpdate". (Other, None, LockedForUpdate)
productCategory	string	The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other.
productType	string	Type of the product for which the subscription is purchased.
productTypeId	string	Id of the product for which the subscription is purchased.
provisioningState	string	The provisioning state of the resource during a long-running operation. Known values are: "Succeeded", "Canceled", "Failed", "New", "Pending", "Provisioning", "PendingBilling", "ConfirmedBilling", "Creating", "Created", and "Expired". (Succeeded, Canceled, Failed, New, Pending, Provisioning, PendingBilling, ConfirmedBilling, Creating, Created, Expired)
provisioningTenantId	string	The tenant in which the subscription is provisioned.
purchaseDate	string (date-time)	Purchase date of the product in UTC time.
quantity	integer	The quantity of licenses or fulfillment units for the subscription.
renewalTermDetails	object	Details for the next renewal term of a subscription.
reseller	object	Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts.
resourceUri	string	Unique identifier of the linked resource.
skuDescription	string	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	string	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	string	The status of the subscription. This field is not available for Enterprise Agreement billing accounts. 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)
subscriptionId	string	The ID of the subscription.
suspensionReasonDetails	array	The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.
suspensionReasons	array	The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemOverrides	object	System imposed policies that regulate behavior of the subscription.
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 < > % & \ ? /.
termDuration	string	The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y.
termEndDate	string (date-time)	End date of the term in UTC time.
termStartDate	string (date-time)	Start date of the term in UTC time.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_billing_account

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.
autoRenew	string	Indicates whether auto renewal is turned on or off for a product. Known values are: "Off" and "On". (Off, On)
beneficiary	object	The beneficiary of the billing subscription.
beneficiaryTenantId	string	The provisioning tenant of the subscription.
billingFrequency	string	The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y.
billingPolicies	object	Dictionary of billing policies associated with the subscription.
billingProfileDisplayName	string	The name of the billing profile.
billingProfileId	string	The fully qualified ID that uniquely identifies a billing profile.
billingProfileName	string	The ID that uniquely identifies a billing profile.
consumptionCostCenter	string	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	string	The name of the customer.
customerId	string	The fully qualified ID that uniquely identifies a customer.
customerName	string	The ID that uniquely identifies a customer.
displayName	string	The name of the billing subscription.
enrollmentAccountDisplayName	string	The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.
enrollmentAccountId	string	The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.
enrollmentAccountSubscriptionDetails	object	Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts.
invoiceSectionDisplayName	string	The name of the invoice section.
invoiceSectionId	string	The fully qualified ID that uniquely identifies an invoice section.
invoiceSectionName	string	The ID that uniquely identifies an invoice section.
lastMonthCharges	object	The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.
monthToDateCharges	object	The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.
nextBillingCycleDetails	object	Next billing cycle details of the subscription.
offerId	string	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	string	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. Known values are: "Other", "None", and "LockedForUpdate". (Other, None, LockedForUpdate)
productCategory	string	The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other.
productType	string	Type of the product for which the subscription is purchased.
productTypeId	string	Id of the product for which the subscription is purchased.
provisioningState	string	The provisioning state of the resource during a long-running operation. Known values are: "Succeeded", "Canceled", "Failed", "New", "Pending", "Provisioning", "PendingBilling", "ConfirmedBilling", "Creating", "Created", and "Expired". (Succeeded, Canceled, Failed, New, Pending, Provisioning, PendingBilling, ConfirmedBilling, Creating, Created, Expired)
provisioningTenantId	string	The tenant in which the subscription is provisioned.
purchaseDate	string (date-time)	Purchase date of the product in UTC time.
quantity	integer	The quantity of licenses or fulfillment units for the subscription.
renewalTermDetails	object	Details for the next renewal term of a subscription.
reseller	object	Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts.
resourceUri	string	Unique identifier of the linked resource.
skuDescription	string	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	string	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	string	The status of the subscription. This field is not available for Enterprise Agreement billing accounts. 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)
subscriptionId	string	The ID of the subscription.
suspensionReasonDetails	array	The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.
suspensionReasons	array	The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemOverrides	object	System imposed policies that regulate behavior of the subscription.
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 < > % & \ ? /.
termDuration	string	The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y.
termEndDate	string (date-time)	End date of the term in UTC time.
termStartDate	string (date-time)	Start date of the term in UTC time.
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
list_by_customer	select	billing_account_name, billing_profile_name, customer_name	includeDeleted, expand, filter, orderBy, top, skip, count, search	Lists the subscriptions for a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
list_by_invoice_section	select	billing_account_name, billing_profile_name, invoice_section_name	includeDeleted, expand, filter, orderBy, top, skip, count, search	Lists the subscriptions that are billed to an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
get_by_billing_profile	select	billing_account_name, billing_profile_name, billing_subscription_name	expand	Gets a subscription by its billing profile and ID. The operation is supported for billing accounts with agreement type Enterprise Agreement.
get	select	billing_account_name, billing_subscription_name	expand	Gets a subscription by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement, Microsoft Partner Agreement, and Enterprise Agreement.
list_by_billing_profile	select	billing_account_name, billing_profile_name	includeDeleted, expand, filter, orderBy, top, skip, count, search	Lists the subscriptions that are billed to a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
list_by_customer_at_billing_account	select	billing_account_name, customer_name	includeDeleted, expand, filter, orderBy, top, skip, count, search	Lists the subscriptions for a customer at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
list_by_enrollment_account	select	billing_account_name, enrollment_account_name	filter, orderBy, top, skip, count, search	Lists the subscriptions for an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.
list_by_billing_account	select	billing_account_name	includeDeleted, includeTenantSubscriptions, includeFailed, expand, filter, orderBy, top, skip, count, search	Lists the subscriptions for a billing account.
update	update	billing_account_name, billing_subscription_name		Updates the properties of a billing subscription.
delete	delete	billing_account_name, billing_subscription_name		Cancels a billing subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement or Microsoft Customer Agreement.
cancel	exec	billing_account_name, billing_subscription_name, cancellationReason		Cancels a usage-based subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement.
merge	exec	billing_account_name, billing_subscription_name		Merges the billing subscription provided in the request with a target billing subscription.
move	exec	billing_account_name, billing_subscription_name		Moves charges for a subscription to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
split	exec	billing_account_name, billing_subscription_name		Splits a subscription into a new subscription with quantity less than current subscription quantity and not equal to 0.
validate_move_eligibility	exec	billing_account_name, billing_subscription_name		Validates if charges for a subscription can be moved to a new invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

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
billing_account_name	string	The ID that uniquely identifies a billing account. Required.
billing_profile_name	string	The ID that uniquely identifies a billing profile. Required.
billing_subscription_name	string	The ID that uniquely identifies a subscription. Required.
customer_name	string	The ID that uniquely identifies a customer. Required.
enrollment_account_name	string	The name of the enrollment account. Required.
invoice_section_name	string	The ID that uniquely identifies an invoice section. Required.
count	boolean	The count query option allows clients to request a count of the matching resources included with the resources in the response. Default value is None.
expand	string	Can be used to expand Reseller, ConsumptionCostCenter, LastMonthCharges and MonthToDateCharges. Default value is None.
filter	string	The filter query option allows clients to filter a collection of resources that are addressed by a request URL. Default value is None.
includeDeleted	boolean	Can be used to get deleted billing subscriptions. Default value is False.
includeFailed	boolean	Can be used to get failed billing subscriptions. Default value is False.
includeTenantSubscriptions	boolean	Can be used to get tenant-owned billing subscriptions. This field is only applies to Microsoft Online Services Program billing accounts. Default value is False.
orderBy	string	The orderby query option allows clients to request resources in a particular order. Default value is None.
search	string	The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. Default value is None.
skip	integer	The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. Default value is None.
top	integer	The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. Default value is None.

SELECT examples

list_by_customer

Lists the subscriptions for a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

SELECT
id,
name,
autoRenew,
beneficiary,
beneficiaryTenantId,
billingFrequency,
billingPolicies,
billingProfileDisplayName,
billingProfileId,
billingProfileName,
consumptionCostCenter,
customerDisplayName,
customerId,
customerName,
displayName,
enrollmentAccountDisplayName,
enrollmentAccountId,
enrollmentAccountSubscriptionDetails,
invoiceSectionDisplayName,
invoiceSectionId,
invoiceSectionName,
lastMonthCharges,
monthToDateCharges,
nextBillingCycleDetails,
offerId,
operationStatus,
productCategory,
productType,
productTypeId,
provisioningState,
provisioningTenantId,
purchaseDate,
quantity,
renewalTermDetails,
reseller,
resourceUri,
skuDescription,
skuId,
status,
subscriptionId,
suspensionReasonDetails,
suspensionReasons,
systemData,
systemOverrides,
tags,
termDuration,
termEndDate,
termStartDate,
type
FROM azure.billing.billing_subscriptions
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND billing_profile_name = '{{ billing_profile_name }}' -- required
AND customer_name = '{{ customer_name }}' -- required
AND includeDeleted = '{{ includeDeleted }}'
AND expand = '{{ expand }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND count = '{{ count }}'
AND search = '{{ search }}'
;

list_by_invoice_section

Lists the subscriptions that are billed to an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

SELECT
id,
name,
autoRenew,
beneficiary,
beneficiaryTenantId,
billingFrequency,
billingPolicies,
billingProfileDisplayName,
billingProfileId,
billingProfileName,
consumptionCostCenter,
customerDisplayName,
customerId,
customerName,
displayName,
enrollmentAccountDisplayName,
enrollmentAccountId,
enrollmentAccountSubscriptionDetails,
invoiceSectionDisplayName,
invoiceSectionId,
invoiceSectionName,
lastMonthCharges,
monthToDateCharges,
nextBillingCycleDetails,
offerId,
operationStatus,
productCategory,
productType,
productTypeId,
provisioningState,
provisioningTenantId,
purchaseDate,
quantity,
renewalTermDetails,
reseller,
resourceUri,
skuDescription,
skuId,
status,
subscriptionId,
suspensionReasonDetails,
suspensionReasons,
systemData,
systemOverrides,
tags,
termDuration,
termEndDate,
termStartDate,
type
FROM azure.billing.billing_subscriptions
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND billing_profile_name = '{{ billing_profile_name }}' -- required
AND invoice_section_name = '{{ invoice_section_name }}' -- required
AND includeDeleted = '{{ includeDeleted }}'
AND expand = '{{ expand }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND count = '{{ count }}'
AND search = '{{ search }}'
;

get_by_billing_profile

Gets a subscription by its billing profile and ID. The operation is supported for billing accounts with agreement type Enterprise Agreement.

SELECT
id,
name,
autoRenew,
beneficiary,
beneficiaryTenantId,
billingFrequency,
billingPolicies,
billingProfileDisplayName,
billingProfileId,
billingProfileName,
consumptionCostCenter,
customerDisplayName,
customerId,
customerName,
displayName,
enrollmentAccountDisplayName,
enrollmentAccountId,
enrollmentAccountSubscriptionDetails,
invoiceSectionDisplayName,
invoiceSectionId,
invoiceSectionName,
lastMonthCharges,
monthToDateCharges,
nextBillingCycleDetails,
offerId,
operationStatus,
productCategory,
productType,
productTypeId,
provisioningState,
provisioningTenantId,
purchaseDate,
quantity,
renewalTermDetails,
reseller,
resourceUri,
skuDescription,
skuId,
status,
subscriptionId,
suspensionReasonDetails,
suspensionReasons,
systemData,
systemOverrides,
tags,
termDuration,
termEndDate,
termStartDate,
type
FROM azure.billing.billing_subscriptions
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND billing_profile_name = '{{ billing_profile_name }}' -- required
AND billing_subscription_name = '{{ billing_subscription_name }}' -- required
AND expand = '{{ expand }}'
;

get

Gets a subscription by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement, Microsoft Partner Agreement, and Enterprise Agreement.

SELECT
id,
name,
autoRenew,
beneficiary,
beneficiaryTenantId,
billingFrequency,
billingPolicies,
billingProfileDisplayName,
billingProfileId,
billingProfileName,
consumptionCostCenter,
customerDisplayName,
customerId,
customerName,
displayName,
enrollmentAccountDisplayName,
enrollmentAccountId,
enrollmentAccountSubscriptionDetails,
invoiceSectionDisplayName,
invoiceSectionId,
invoiceSectionName,
lastMonthCharges,
monthToDateCharges,
nextBillingCycleDetails,
offerId,
operationStatus,
productCategory,
productType,
productTypeId,
provisioningState,
provisioningTenantId,
purchaseDate,
quantity,
renewalTermDetails,
reseller,
resourceUri,
skuDescription,
skuId,
status,
subscriptionId,
suspensionReasonDetails,
suspensionReasons,
systemData,
systemOverrides,
tags,
termDuration,
termEndDate,
termStartDate,
type
FROM azure.billing.billing_subscriptions
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND billing_subscription_name = '{{ billing_subscription_name }}' -- required
AND expand = '{{ expand }}'
;

list_by_billing_profile

Lists the subscriptions that are billed to a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.

SELECT
id,
name,
autoRenew,
beneficiary,
beneficiaryTenantId,
billingFrequency,
billingPolicies,
billingProfileDisplayName,
billingProfileId,
billingProfileName,
consumptionCostCenter,
customerDisplayName,
customerId,
customerName,
displayName,
enrollmentAccountDisplayName,
enrollmentAccountId,
enrollmentAccountSubscriptionDetails,
invoiceSectionDisplayName,
invoiceSectionId,
invoiceSectionName,
lastMonthCharges,
monthToDateCharges,
nextBillingCycleDetails,
offerId,
operationStatus,
productCategory,
productType,
productTypeId,
provisioningState,
provisioningTenantId,
purchaseDate,
quantity,
renewalTermDetails,
reseller,
resourceUri,
skuDescription,
skuId,
status,
subscriptionId,
suspensionReasonDetails,
suspensionReasons,
systemData,
systemOverrides,
tags,
termDuration,
termEndDate,
termStartDate,
type
FROM azure.billing.billing_subscriptions
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND billing_profile_name = '{{ billing_profile_name }}' -- required
AND includeDeleted = '{{ includeDeleted }}'
AND expand = '{{ expand }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND count = '{{ count }}'
AND search = '{{ search }}'
;

list_by_customer_at_billing_account

Lists the subscriptions for a customer at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

SELECT
id,
name,
autoRenew,
beneficiary,
beneficiaryTenantId,
billingFrequency,
billingPolicies,
billingProfileDisplayName,
billingProfileId,
billingProfileName,
consumptionCostCenter,
customerDisplayName,
customerId,
customerName,
displayName,
enrollmentAccountDisplayName,
enrollmentAccountId,
enrollmentAccountSubscriptionDetails,
invoiceSectionDisplayName,
invoiceSectionId,
invoiceSectionName,
lastMonthCharges,
monthToDateCharges,
nextBillingCycleDetails,
offerId,
operationStatus,
productCategory,
productType,
productTypeId,
provisioningState,
provisioningTenantId,
purchaseDate,
quantity,
renewalTermDetails,
reseller,
resourceUri,
skuDescription,
skuId,
status,
subscriptionId,
suspensionReasonDetails,
suspensionReasons,
systemData,
systemOverrides,
tags,
termDuration,
termEndDate,
termStartDate,
type
FROM azure.billing.billing_subscriptions
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND customer_name = '{{ customer_name }}' -- required
AND includeDeleted = '{{ includeDeleted }}'
AND expand = '{{ expand }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND count = '{{ count }}'
AND search = '{{ search }}'
;

list_by_enrollment_account

Lists the subscriptions for an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.

SELECT
id,
name,
autoRenew,
beneficiary,
beneficiaryTenantId,
billingFrequency,
billingPolicies,
billingProfileDisplayName,
billingProfileId,
billingProfileName,
consumptionCostCenter,
customerDisplayName,
customerId,
customerName,
displayName,
enrollmentAccountDisplayName,
enrollmentAccountId,
enrollmentAccountSubscriptionDetails,
invoiceSectionDisplayName,
invoiceSectionId,
invoiceSectionName,
lastMonthCharges,
monthToDateCharges,
nextBillingCycleDetails,
offerId,
operationStatus,
productCategory,
productType,
productTypeId,
provisioningState,
provisioningTenantId,
purchaseDate,
quantity,
renewalTermDetails,
reseller,
resourceUri,
skuDescription,
skuId,
status,
subscriptionId,
suspensionReasonDetails,
suspensionReasons,
systemData,
systemOverrides,
tags,
termDuration,
termEndDate,
termStartDate,
type
FROM azure.billing.billing_subscriptions
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND enrollment_account_name = '{{ enrollment_account_name }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND count = '{{ count }}'
AND search = '{{ search }}'
;

list_by_billing_account

Lists the subscriptions for a billing account.

SELECT
id,
name,
autoRenew,
beneficiary,
beneficiaryTenantId,
billingFrequency,
billingPolicies,
billingProfileDisplayName,
billingProfileId,
billingProfileName,
consumptionCostCenter,
customerDisplayName,
customerId,
customerName,
displayName,
enrollmentAccountDisplayName,
enrollmentAccountId,
enrollmentAccountSubscriptionDetails,
invoiceSectionDisplayName,
invoiceSectionId,
invoiceSectionName,
lastMonthCharges,
monthToDateCharges,
nextBillingCycleDetails,
offerId,
operationStatus,
productCategory,
productType,
productTypeId,
provisioningState,
provisioningTenantId,
purchaseDate,
quantity,
renewalTermDetails,
reseller,
resourceUri,
skuDescription,
skuId,
status,
subscriptionId,
suspensionReasonDetails,
suspensionReasons,
systemData,
systemOverrides,
tags,
termDuration,
termEndDate,
termStartDate,
type
FROM azure.billing.billing_subscriptions
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND includeDeleted = '{{ includeDeleted }}'
AND includeTenantSubscriptions = '{{ includeTenantSubscriptions }}'
AND includeFailed = '{{ includeFailed }}'
AND expand = '{{ expand }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND count = '{{ count }}'
AND search = '{{ search }}'
;

UPDATE examples

update

Updates the properties of a billing subscription.

UPDATE azure.billing.billing_subscriptions
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
billing_account_name = '{{ billing_account_name }}' --required
AND billing_subscription_name = '{{ billing_subscription_name }}' --required
RETURNING
id,
name,
properties,
systemData,
tags,
type;

DELETE examples

delete

Cancels a billing subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement or Microsoft Customer Agreement.

DELETE FROM azure.billing.billing_subscriptions
WHERE billing_account_name = '{{ billing_account_name }}' --required
AND billing_subscription_name = '{{ billing_subscription_name }}' --required
;

Lifecycle Methods

cancel

Cancels a usage-based subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement.

EXEC azure.billing.billing_subscriptions.cancel 
@billing_account_name='{{ billing_account_name }}' --required, 
@billing_subscription_name='{{ billing_subscription_name }}' --required 
@@json=
'{
"cancellationReason": "{{ cancellationReason }}", 
"customerId": "{{ customerId }}"
}'
;

merge

Merges the billing subscription provided in the request with a target billing subscription.

EXEC azure.billing.billing_subscriptions.merge 
@billing_account_name='{{ billing_account_name }}' --required, 
@billing_subscription_name='{{ billing_subscription_name }}' --required 
@@json=
'{
"targetBillingSubscriptionName": "{{ targetBillingSubscriptionName }}", 
"quantity": {{ quantity }}
}'
;

move

Moves charges for a subscription to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

EXEC azure.billing.billing_subscriptions.move 
@billing_account_name='{{ billing_account_name }}' --required, 
@billing_subscription_name='{{ billing_subscription_name }}' --required 
@@json=
'{
"destinationInvoiceSectionId": "{{ destinationInvoiceSectionId }}", 
"destinationEnrollmentAccountId": "{{ destinationEnrollmentAccountId }}"
}'
;

split

Splits a subscription into a new subscription with quantity less than current subscription quantity and not equal to 0.

EXEC azure.billing.billing_subscriptions.split 
@billing_account_name='{{ billing_account_name }}' --required, 
@billing_subscription_name='{{ billing_subscription_name }}' --required 
@@json=
'{
"targetProductTypeId": "{{ targetProductTypeId }}", 
"targetSkuId": "{{ targetSkuId }}", 
"quantity": {{ quantity }}, 
"termDuration": "{{ termDuration }}", 
"billingFrequency": "{{ billingFrequency }}"
}'
;

validate_move_eligibility

Validates if charges for a subscription can be moved to a new invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.

EXEC azure.billing.billing_subscriptions.validate_move_eligibility 
@billing_account_name='{{ billing_account_name }}' --required, 
@billing_subscription_name='{{ billing_subscription_name }}' --required 
@@json=
'{
"destinationInvoiceSectionId": "{{ destinationInvoiceSectionId }}", 
"destinationEnrollmentAccountId": "{{ destinationEnrollmentAccountId }}"
}'
;