Microsoft.Billing billingAccounts/billingProfiles 2024-04-01

• Latest
• 2024-04-01
• 2020-05-01
• 2019-10-01-preview
• 2018-11-01-preview

Bicep resource definition

The billingAccounts/billingProfiles resource type can be deployed with operations that target:

• Tenant - See tenant deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Billing/billingAccounts/billingProfiles resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Billing/billingAccounts/billingProfiles@2024-04-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    billTo: {
      addressLine1: 'string'
      addressLine2: 'string'
      addressLine3: 'string'
      city: 'string'
      companyName: 'string'
      country: 'string'
      district: 'string'
      email: 'string'
      firstName: 'string'
      isValidAddress: bool
      lastName: 'string'
      middleName: 'string'
      phoneNumber: 'string'
      postalCode: 'string'
      region: 'string'
    }
    currentPaymentTerm: {
      endDate: 'string'
      startDate: 'string'
      term: 'string'
    }
    displayName: 'string'
    enabledAzurePlans: [
      {
        productId: 'string'
        skuDescription: 'string'
        skuId: 'string'
      }
    ]
    indirectRelationshipInfo: {
      billingAccountName: 'string'
      billingProfileName: 'string'
      displayName: 'string'
    }
    invoiceEmailOptIn: bool
    invoiceRecipients: [
      'string'
    ]
    poNumber: 'string'
    shipTo: {
      addressLine1: 'string'
      addressLine2: 'string'
      addressLine3: 'string'
      city: 'string'
      companyName: 'string'
      country: 'string'
      district: 'string'
      email: 'string'
      firstName: 'string'
      isValidAddress: bool
      lastName: 'string'
      middleName: 'string'
      phoneNumber: 'string'
      postalCode: 'string'
      region: 'string'
    }
    soldTo: {
      addressLine1: 'string'
      addressLine2: 'string'
      addressLine3: 'string'
      city: 'string'
      companyName: 'string'
      country: 'string'
      district: 'string'
      email: 'string'
      firstName: 'string'
      isValidAddress: bool
      lastName: 'string'
      middleName: 'string'
      phoneNumber: 'string'
      postalCode: 'string'
      region: 'string'
    }
    tags: {
      {customized property}: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

AzurePlan

Name	Description	Value
productId	The ID that uniquely identifies a product.	string
skuDescription	The sku description.	string
skuId	The ID that uniquely identifies a sku.	string

BillingProfileProperties

Name	Description	Value
billTo	Billing address.	BillingProfilePropertiesBillTo
currentPaymentTerm	The current payment term of the billing profile.	BillingProfilePropertiesCurrentPaymentTerm
displayName	The name of the billing profile.	string
enabledAzurePlans	Information about the enabled azure plans.	AzurePlan[]
indirectRelationshipInfo	Identifies the billing profile that is linked to another billing profile in indirect purchase motion.	BillingProfilePropertiesIndirectRelationshipInfo
invoiceEmailOptIn	Flag controlling whether the invoices for the billing profile are sent through email.	bool
invoiceRecipients	The list of email addresses to receive invoices by email for the billing profile.	string[]
poNumber	The default purchase order number that will appear on the invoices generated for the billing profile.	string
shipTo	The default address where the products are shipped, or the services are being used. If a ship to is not specified for a product or a subscription, then this address will be used.	BillingProfilePropertiesShipTo
soldTo	The address of the individual or organization that is responsible for the billing account.	BillingProfilePropertiesSoldTo
tags	Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /	BillingProfilePropertiesTags

BillingProfilePropertiesBillTo

Name	Description	Value
addressLine1	Address line 1.	string Constraints: Min length = 1 (required)
addressLine2	Address line 2.	string
addressLine3	Address line 3.	string
city	Address city.	string
companyName	Company name. Optional for MCA Individual (Pay-as-you-go).	string
country	Country code uses ISO 3166-1 Alpha-2 format.	string Constraints: Min length = 1 (required)
district	Address district.	string
email	Email address.	string
firstName	First name. Optional for MCA Enterprise.	string
isValidAddress	Indicates if the address is incomplete.	bool
lastName	Last name. Optional for MCA Enterprise.	string
middleName	Middle name.	string
phoneNumber	Phone number.	string
postalCode	Postal code.	string
region	Address region.	string

BillingProfilePropertiesCurrentPaymentTerm

Name	Description	Value
endDate	The date on when the defined 'Payment Term' will end and is always in UTC.	string
startDate	The date on when the defined 'Payment Term' will be effective from and is always in UTC.	string
term	Represents duration in netXX format. Always in days.	string

BillingProfilePropertiesIndirectRelationshipInfo

Name	Description	Value
billingAccountName	The billing account name of the partner or the customer for an indirect motion.	string
billingProfileName	The billing profile name of the partner or the customer for an indirect motion.	string
displayName	The display name of the partner or customer for an indirect motion.	string

BillingProfilePropertiesShipTo

Name	Description	Value
addressLine1	Address line 1.	string Constraints: Min length = 1 (required)
addressLine2	Address line 2.	string
addressLine3	Address line 3.	string
city	Address city.	string
companyName	Company name. Optional for MCA Individual (Pay-as-you-go).	string
country	Country code uses ISO 3166-1 Alpha-2 format.	string Constraints: Min length = 1 (required)
district	Address district.	string
email	Email address.	string
firstName	First name. Optional for MCA Enterprise.	string
isValidAddress	Indicates if the address is incomplete.	bool
lastName	Last name. Optional for MCA Enterprise.	string
middleName	Middle name.	string
phoneNumber	Phone number.	string
postalCode	Postal code.	string
region	Address region.	string

BillingProfilePropertiesSoldTo

Name	Description	Value
addressLine1	Address line 1.	string Constraints: Min length = 1 (required)
addressLine2	Address line 2.	string
addressLine3	Address line 3.	string
city	Address city.	string
companyName	Company name. Optional for MCA Individual (Pay-as-you-go).	string
country	Country code uses ISO 3166-1 Alpha-2 format.	string Constraints: Min length = 1 (required)
district	Address district.	string
email	Email address.	string
firstName	First name. Optional for MCA Enterprise.	string
isValidAddress	Indicates if the address is incomplete.	bool
lastName	Last name. Optional for MCA Enterprise.	string
middleName	Middle name.	string
phoneNumber	Phone number.	string
postalCode	Postal code.	string
region	Address region.	string

BillingProfilePropertiesTags

Name	Description	Value

Microsoft.Billing/billingAccounts/billingProfiles

Name	Description	Value
name	The resource name	string Constraints: Pattern = ^[a-zA-Z\d-_]{1,128}$ (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: billingAccounts
properties	A billing profile.	BillingProfileProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

ProxyResourceWithTags

Name	Description	Value

ARM template resource definition

The billingAccounts/billingProfiles resource type can be deployed with operations that target:

• Tenant - See tenant deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Billing/billingAccounts/billingProfiles resource, add the following JSON to your template.

{
  "type": "Microsoft.Billing/billingAccounts/billingProfiles",
  "apiVersion": "2024-04-01",
  "name": "string",
  "properties": {
    "billTo": {
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "city": "string",
      "companyName": "string",
      "country": "string",
      "district": "string",
      "email": "string",
      "firstName": "string",
      "isValidAddress": "bool",
      "lastName": "string",
      "middleName": "string",
      "phoneNumber": "string",
      "postalCode": "string",
      "region": "string"
    },
    "currentPaymentTerm": {
      "endDate": "string",
      "startDate": "string",
      "term": "string"
    },
    "displayName": "string",
    "enabledAzurePlans": [
      {
        "productId": "string",
        "skuDescription": "string",
        "skuId": "string"
      }
    ],
    "indirectRelationshipInfo": {
      "billingAccountName": "string",
      "billingProfileName": "string",
      "displayName": "string"
    },
    "invoiceEmailOptIn": "bool",
    "invoiceRecipients": [ "string" ],
    "poNumber": "string",
    "shipTo": {
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "city": "string",
      "companyName": "string",
      "country": "string",
      "district": "string",
      "email": "string",
      "firstName": "string",
      "isValidAddress": "bool",
      "lastName": "string",
      "middleName": "string",
      "phoneNumber": "string",
      "postalCode": "string",
      "region": "string"
    },
    "soldTo": {
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "city": "string",
      "companyName": "string",
      "country": "string",
      "district": "string",
      "email": "string",
      "firstName": "string",
      "isValidAddress": "bool",
      "lastName": "string",
      "middleName": "string",
      "phoneNumber": "string",
      "postalCode": "string",
      "region": "string"
    },
    "tags": {
      "{customized property}": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

AzurePlan

Name	Description	Value
productId	The ID that uniquely identifies a product.	string
skuDescription	The sku description.	string
skuId	The ID that uniquely identifies a sku.	string

BillingProfileProperties

Name	Description	Value
billTo	Billing address.	BillingProfilePropertiesBillTo
currentPaymentTerm	The current payment term of the billing profile.	BillingProfilePropertiesCurrentPaymentTerm
displayName	The name of the billing profile.	string
enabledAzurePlans	Information about the enabled azure plans.	AzurePlan[]
indirectRelationshipInfo	Identifies the billing profile that is linked to another billing profile in indirect purchase motion.	BillingProfilePropertiesIndirectRelationshipInfo
invoiceEmailOptIn	Flag controlling whether the invoices for the billing profile are sent through email.	bool
invoiceRecipients	The list of email addresses to receive invoices by email for the billing profile.	string[]
poNumber	The default purchase order number that will appear on the invoices generated for the billing profile.	string
shipTo	The default address where the products are shipped, or the services are being used. If a ship to is not specified for a product or a subscription, then this address will be used.	BillingProfilePropertiesShipTo
soldTo	The address of the individual or organization that is responsible for the billing account.	BillingProfilePropertiesSoldTo
tags	Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /	BillingProfilePropertiesTags

BillingProfilePropertiesBillTo

Name	Description	Value
addressLine1	Address line 1.	string Constraints: Min length = 1 (required)
addressLine2	Address line 2.	string
addressLine3	Address line 3.	string
city	Address city.	string
companyName	Company name. Optional for MCA Individual (Pay-as-you-go).	string
country	Country code uses ISO 3166-1 Alpha-2 format.	string Constraints: Min length = 1 (required)
district	Address district.	string
email	Email address.	string
firstName	First name. Optional for MCA Enterprise.	string
isValidAddress	Indicates if the address is incomplete.	bool
lastName	Last name. Optional for MCA Enterprise.	string
middleName	Middle name.	string
phoneNumber	Phone number.	string
postalCode	Postal code.	string
region	Address region.	string

BillingProfilePropertiesCurrentPaymentTerm

Name	Description	Value
endDate	The date on when the defined 'Payment Term' will end and is always in UTC.	string
startDate	The date on when the defined 'Payment Term' will be effective from and is always in UTC.	string
term	Represents duration in netXX format. Always in days.	string

BillingProfilePropertiesIndirectRelationshipInfo

Name	Description	Value
billingAccountName	The billing account name of the partner or the customer for an indirect motion.	string
billingProfileName	The billing profile name of the partner or the customer for an indirect motion.	string
displayName	The display name of the partner or customer for an indirect motion.	string

BillingProfilePropertiesShipTo

Name	Description	Value
addressLine1	Address line 1.	string Constraints: Min length = 1 (required)
addressLine2	Address line 2.	string
addressLine3	Address line 3.	string
city	Address city.	string
companyName	Company name. Optional for MCA Individual (Pay-as-you-go).	string
country	Country code uses ISO 3166-1 Alpha-2 format.	string Constraints: Min length = 1 (required)
district	Address district.	string
email	Email address.	string
firstName	First name. Optional for MCA Enterprise.	string
isValidAddress	Indicates if the address is incomplete.	bool
lastName	Last name. Optional for MCA Enterprise.	string
middleName	Middle name.	string
phoneNumber	Phone number.	string
postalCode	Postal code.	string
region	Address region.	string

BillingProfilePropertiesSoldTo

Name	Description	Value
addressLine1	Address line 1.	string Constraints: Min length = 1 (required)
addressLine2	Address line 2.	string
addressLine3	Address line 3.	string
city	Address city.	string
companyName	Company name. Optional for MCA Individual (Pay-as-you-go).	string
country	Country code uses ISO 3166-1 Alpha-2 format.	string Constraints: Min length = 1 (required)
district	Address district.	string
email	Email address.	string
firstName	First name. Optional for MCA Enterprise.	string
isValidAddress	Indicates if the address is incomplete.	bool
lastName	Last name. Optional for MCA Enterprise.	string
middleName	Middle name.	string
phoneNumber	Phone number.	string
postalCode	Postal code.	string
region	Address region.	string

BillingProfilePropertiesTags

Name	Description	Value

Microsoft.Billing/billingAccounts/billingProfiles

Name	Description	Value
apiVersion	The api version	'2024-04-01'
name	The resource name	string Constraints: Pattern = ^[a-zA-Z\d-_]{1,128}$ (required)
properties	A billing profile.	BillingProfileProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.Billing/billingAccounts/billingProfiles'

ProxyResourceWithTags

Name	Description	Value

Terraform (AzAPI provider) resource definition

The billingAccounts/billingProfiles resource type can be deployed with operations that target:

• Tenant

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Billing/billingAccounts/billingProfiles resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Billing/billingAccounts/billingProfiles@2024-04-01"
  name = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      billTo = {
        addressLine1 = "string"
        addressLine2 = "string"
        addressLine3 = "string"
        city = "string"
        companyName = "string"
        country = "string"
        district = "string"
        email = "string"
        firstName = "string"
        isValidAddress = bool
        lastName = "string"
        middleName = "string"
        phoneNumber = "string"
        postalCode = "string"
        region = "string"
      }
      currentPaymentTerm = {
        endDate = "string"
        startDate = "string"
        term = "string"
      }
      displayName = "string"
      enabledAzurePlans = [
        {
          productId = "string"
          skuDescription = "string"
          skuId = "string"
        }
      ]
      indirectRelationshipInfo = {
        billingAccountName = "string"
        billingProfileName = "string"
        displayName = "string"
      }
      invoiceEmailOptIn = bool
      invoiceRecipients = [
        "string"
      ]
      poNumber = "string"
      shipTo = {
        addressLine1 = "string"
        addressLine2 = "string"
        addressLine3 = "string"
        city = "string"
        companyName = "string"
        country = "string"
        district = "string"
        email = "string"
        firstName = "string"
        isValidAddress = bool
        lastName = "string"
        middleName = "string"
        phoneNumber = "string"
        postalCode = "string"
        region = "string"
      }
      soldTo = {
        addressLine1 = "string"
        addressLine2 = "string"
        addressLine3 = "string"
        city = "string"
        companyName = "string"
        country = "string"
        district = "string"
        email = "string"
        firstName = "string"
        isValidAddress = bool
        lastName = "string"
        middleName = "string"
        phoneNumber = "string"
        postalCode = "string"
        region = "string"
      }
      tags = {
        {customized property} = "string"
      }
    }
  })
}

Property values

AzurePlan

Name	Description	Value
productId	The ID that uniquely identifies a product.	string
skuDescription	The sku description.	string
skuId	The ID that uniquely identifies a sku.	string

BillingProfileProperties

Name	Description	Value
billTo	Billing address.	BillingProfilePropertiesBillTo
currentPaymentTerm	The current payment term of the billing profile.	BillingProfilePropertiesCurrentPaymentTerm
displayName	The name of the billing profile.	string
enabledAzurePlans	Information about the enabled azure plans.	AzurePlan[]
indirectRelationshipInfo	Identifies the billing profile that is linked to another billing profile in indirect purchase motion.	BillingProfilePropertiesIndirectRelationshipInfo
invoiceEmailOptIn	Flag controlling whether the invoices for the billing profile are sent through email.	bool
invoiceRecipients	The list of email addresses to receive invoices by email for the billing profile.	string[]
poNumber	The default purchase order number that will appear on the invoices generated for the billing profile.	string
shipTo	The default address where the products are shipped, or the services are being used. If a ship to is not specified for a product or a subscription, then this address will be used.	BillingProfilePropertiesShipTo
soldTo	The address of the individual or organization that is responsible for the billing account.	BillingProfilePropertiesSoldTo
tags	Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /	BillingProfilePropertiesTags

BillingProfilePropertiesBillTo

Name	Description	Value
addressLine1	Address line 1.	string Constraints: Min length = 1 (required)
addressLine2	Address line 2.	string
addressLine3	Address line 3.	string
city	Address city.	string
companyName	Company name. Optional for MCA Individual (Pay-as-you-go).	string
country	Country code uses ISO 3166-1 Alpha-2 format.	string Constraints: Min length = 1 (required)
district	Address district.	string
email	Email address.	string
firstName	First name. Optional for MCA Enterprise.	string
isValidAddress	Indicates if the address is incomplete.	bool
lastName	Last name. Optional for MCA Enterprise.	string
middleName	Middle name.	string
phoneNumber	Phone number.	string
postalCode	Postal code.	string
region	Address region.	string

BillingProfilePropertiesCurrentPaymentTerm

Name	Description	Value
endDate	The date on when the defined 'Payment Term' will end and is always in UTC.	string
startDate	The date on when the defined 'Payment Term' will be effective from and is always in UTC.	string
term	Represents duration in netXX format. Always in days.	string

BillingProfilePropertiesIndirectRelationshipInfo

Name	Description	Value
billingAccountName	The billing account name of the partner or the customer for an indirect motion.	string
billingProfileName	The billing profile name of the partner or the customer for an indirect motion.	string
displayName	The display name of the partner or customer for an indirect motion.	string

BillingProfilePropertiesShipTo

Name	Description	Value
addressLine1	Address line 1.	string Constraints: Min length = 1 (required)
addressLine2	Address line 2.	string
addressLine3	Address line 3.	string
city	Address city.	string
companyName	Company name. Optional for MCA Individual (Pay-as-you-go).	string
country	Country code uses ISO 3166-1 Alpha-2 format.	string Constraints: Min length = 1 (required)
district	Address district.	string
email	Email address.	string
firstName	First name. Optional for MCA Enterprise.	string
isValidAddress	Indicates if the address is incomplete.	bool
lastName	Last name. Optional for MCA Enterprise.	string
middleName	Middle name.	string
phoneNumber	Phone number.	string
postalCode	Postal code.	string
region	Address region.	string

BillingProfilePropertiesSoldTo

Name	Description	Value
addressLine1	Address line 1.	string Constraints: Min length = 1 (required)
addressLine2	Address line 2.	string
addressLine3	Address line 3.	string
city	Address city.	string
companyName	Company name. Optional for MCA Individual (Pay-as-you-go).	string
country	Country code uses ISO 3166-1 Alpha-2 format.	string Constraints: Min length = 1 (required)
district	Address district.	string
email	Email address.	string
firstName	First name. Optional for MCA Enterprise.	string
isValidAddress	Indicates if the address is incomplete.	bool
lastName	Last name. Optional for MCA Enterprise.	string
middleName	Middle name.	string
phoneNumber	Phone number.	string
postalCode	Postal code.	string
region	Address region.	string

BillingProfilePropertiesTags

Name	Description	Value

Microsoft.Billing/billingAccounts/billingProfiles

Name	Description	Value
name	The resource name	string Constraints: Pattern = ^[a-zA-Z\d-_]{1,128}$ (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: billingAccounts
properties	A billing profile.	BillingProfileProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Billing/billingAccounts/billingProfiles@2024-04-01"

ProxyResourceWithTags

Name	Description	Value