Billing Profiles - Create Or Update

Service:

Billing

API Version:

2024-04-01

Creates or updates a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. If you are a MCA Individual (Pay-as-you-go) customer, then please use the Azure portal experience to create the billing profile.

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}?api-version=2024-04-01

URI Parameters

Name	In	Required	Type	Description
billingAccountName	path	True	string pattern: ^([0-9]+|([Pp][Cc][Nn]\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$	The ID that uniquely identifies a billing account.
billingProfileName	path	True	string pattern: ^[a-zA-Z\d-_]{1,128}$	The ID that uniquely identifies a billing profile.
api-version	query	True	string	The version of the API to be used with the client request. The current version is 2024-04-01.

Request Body

Name	Type	Description
properties	BillingProfileProperties	A billing profile.
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 < > % & \ ? /

Responses

Name	Type	Description
200 OK	BillingProfile	A billing profile.
201 Created	BillingProfile	A billing profile.
202 Accepted		An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation. Headers Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Examples

BillingProfilesCreateOrUpdate

Sample request

HTTP

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx?api-version=2024-04-01

{
  "properties": {
    "billTo": {
      "addressLine1": "Test Address1",
      "addressLine2": "Test Address2",
      "addressLine3": "Test Address3",
      "city": "City",
      "companyName": "Contoso",
      "country": "US",
      "email": "abc@contoso.com",
      "firstName": "Test",
      "lastName": "User",
      "phoneNumber": "000-000-0000",
      "postalCode": "00000",
      "region": "WA",
      "isValidAddress": true
    },
    "displayName": "Billing Profile 1",
    "enabledAzurePlans": [
      {
        "skuId": "0001"
      },
      {
        "skuId": "0002"
      }
    ],
    "invoiceEmailOptIn": true,
    "poNumber": "ABC12345",
    "shipTo": {
      "addressLine1": "Test Address1",
      "addressLine2": "Test Address2",
      "addressLine3": "Test Address3",
      "city": "City",
      "companyName": "Contoso",
      "country": "US",
      "email": "abc@contoso.com",
      "firstName": "Test",
      "lastName": "User",
      "phoneNumber": "000-000-0000",
      "postalCode": "00000",
      "region": "WA",
      "isValidAddress": true
    }
  }
}

Java

import com.azure.resourcemanager.billing.fluent.models.BillingProfileInner;
import com.azure.resourcemanager.billing.models.AzurePlan;
import com.azure.resourcemanager.billing.models.BillingProfileProperties;
import com.azure.resourcemanager.billing.models.BillingProfilePropertiesBillTo;
import com.azure.resourcemanager.billing.models.BillingProfilePropertiesShipTo;
import java.util.Arrays;

/**
 * Samples for BillingProfiles CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesCreateOrUpdate
     * .json
     */
    /**
     * Sample code: BillingProfilesCreateOrUpdate.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void billingProfilesCreateOrUpdate(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.billingProfiles()
            .createOrUpdate("00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
                "xxxx-xxxx-xxx-xxx",
                new BillingProfileInner()
                    .withProperties(new BillingProfileProperties()
                        .withBillTo(new BillingProfilePropertiesBillTo().withAddressLine1("Test Address1")
                            .withAddressLine2("Test Address2").withAddressLine3("Test Address3").withCity("City")
                            .withCompanyName("Contoso").withCountry("US").withEmail("abc@contoso.com")
                            .withFirstName("Test").withLastName("User").withPhoneNumber("000-000-0000")
                            .withPostalCode("fakeTokenPlaceholder").withRegion("WA").withIsValidAddress(true))
                        .withDisplayName("Billing Profile 1")
                        .withEnabledAzurePlans(
                            Arrays.asList(new AzurePlan().withSkuId("0001"), new AzurePlan().withSkuId("0002")))
                        .withInvoiceEmailOptIn(true).withPoNumber("ABC12345")
                        .withShipTo(new BillingProfilePropertiesShipTo().withAddressLine1("Test Address1")
                            .withAddressLine2("Test Address2").withAddressLine3("Test Address3").withCity("City")
                            .withCompanyName("Contoso").withCountry("US").withEmail("abc@contoso.com")
                            .withFirstName("Test").withLastName("User").withPhoneNumber("000-000-0000")
                            .withPostalCode("fakeTokenPlaceholder").withRegion("WA").withIsValidAddress(true))),
                com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.billing import BillingManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python billing_profiles_create_or_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = BillingManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.billing_profiles.begin_create_or_update(
        billing_account_name="00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        billing_profile_name="xxxx-xxxx-xxx-xxx",
        parameters={
            "properties": {
                "billTo": {
                    "addressLine1": "Test Address1",
                    "addressLine2": "Test Address2",
                    "addressLine3": "Test Address3",
                    "city": "City",
                    "companyName": "Contoso",
                    "country": "US",
                    "email": "abc@contoso.com",
                    "firstName": "Test",
                    "isValidAddress": True,
                    "lastName": "User",
                    "phoneNumber": "000-000-0000",
                    "postalCode": "00000",
                    "region": "WA",
                },
                "displayName": "Billing Profile 1",
                "enabledAzurePlans": [{"skuId": "0001"}, {"skuId": "0002"}],
                "invoiceEmailOptIn": True,
                "poNumber": "ABC12345",
                "shipTo": {
                    "addressLine1": "Test Address1",
                    "addressLine2": "Test Address2",
                    "addressLine3": "Test Address3",
                    "city": "City",
                    "companyName": "Contoso",
                    "country": "US",
                    "email": "abc@contoso.com",
                    "firstName": "Test",
                    "isValidAddress": True,
                    "lastName": "User",
                    "phoneNumber": "000-000-0000",
                    "postalCode": "00000",
                    "region": "WA",
                },
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesCreateOrUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armbilling_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/billing/armbilling"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c08ac9813477921ad8295b98ced8f82d11b8f913/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesCreateOrUpdate.json
func ExampleProfilesClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbilling.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewProfilesClient().BeginCreateOrUpdate(ctx, "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "xxxx-xxxx-xxx-xxx", armbilling.Profile{
		Properties: &armbilling.ProfileProperties{
			BillTo: &armbilling.ProfilePropertiesBillTo{
				AddressLine1:   to.Ptr("Test Address1"),
				AddressLine2:   to.Ptr("Test Address2"),
				AddressLine3:   to.Ptr("Test Address3"),
				City:           to.Ptr("City"),
				CompanyName:    to.Ptr("Contoso"),
				Country:        to.Ptr("US"),
				Email:          to.Ptr("abc@contoso.com"),
				FirstName:      to.Ptr("Test"),
				IsValidAddress: to.Ptr(true),
				LastName:       to.Ptr("User"),
				PhoneNumber:    to.Ptr("000-000-0000"),
				PostalCode:     to.Ptr("00000"),
				Region:         to.Ptr("WA"),
			},
			DisplayName: to.Ptr("Billing Profile 1"),
			EnabledAzurePlans: []*armbilling.AzurePlan{
				{
					SKUID: to.Ptr("0001"),
				},
				{
					SKUID: to.Ptr("0002"),
				}},
			InvoiceEmailOptIn: to.Ptr(true),
			PoNumber:          to.Ptr("ABC12345"),
			ShipTo: &armbilling.ProfilePropertiesShipTo{
				AddressLine1:   to.Ptr("Test Address1"),
				AddressLine2:   to.Ptr("Test Address2"),
				AddressLine3:   to.Ptr("Test Address3"),
				City:           to.Ptr("City"),
				CompanyName:    to.Ptr("Contoso"),
				Country:        to.Ptr("US"),
				Email:          to.Ptr("abc@contoso.com"),
				FirstName:      to.Ptr("Test"),
				IsValidAddress: to.Ptr(true),
				LastName:       to.Ptr("User"),
				PhoneNumber:    to.Ptr("000-000-0000"),
				PostalCode:     to.Ptr("00000"),
				Region:         to.Ptr("WA"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Profile = armbilling.Profile{
	// 	Name: to.Ptr("xxxx-xxxx-xxx-xxx"),
	// 	Type: to.Ptr("Microsoft.Billing/billingAccounts/billingProfiles"),
	// 	ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx"),
	// 	Properties: &armbilling.ProfileProperties{
	// 		BillTo: &armbilling.ProfilePropertiesBillTo{
	// 			AddressLine1: to.Ptr("Test Address1"),
	// 			AddressLine2: to.Ptr("Test Address2"),
	// 			AddressLine3: to.Ptr("Test Address3"),
	// 			City: to.Ptr("City"),
	// 			CompanyName: to.Ptr("Contoso"),
	// 			Country: to.Ptr("US"),
	// 			Email: to.Ptr("abc@contoso.com"),
	// 			FirstName: to.Ptr("Test"),
	// 			IsValidAddress: to.Ptr(true),
	// 			LastName: to.Ptr("User"),
	// 			PhoneNumber: to.Ptr("000-000-0000"),
	// 			PostalCode: to.Ptr("00000"),
	// 			Region: to.Ptr("WA"),
	// 		},
	// 		Currency: to.Ptr("USD"),
	// 		DisplayName: to.Ptr("Billing Profile 1"),
	// 		HasReadAccess: to.Ptr(true),
	// 		InvoiceDay: to.Ptr[int32](5),
	// 		InvoiceEmailOptIn: to.Ptr(true),
	// 		PoNumber: to.Ptr("ABC12345"),
	// 		ShipTo: &armbilling.ProfilePropertiesShipTo{
	// 			AddressLine1: to.Ptr("Test Address1"),
	// 			AddressLine2: to.Ptr("Test Address2"),
	// 			AddressLine3: to.Ptr("Test Address3"),
	// 			City: to.Ptr("City"),
	// 			CompanyName: to.Ptr("Contoso"),
	// 			Country: to.Ptr("US"),
	// 			Email: to.Ptr("abc@contoso.com"),
	// 			FirstName: to.Ptr("Test"),
	// 			IsValidAddress: to.Ptr(true),
	// 			LastName: to.Ptr("User"),
	// 			PhoneNumber: to.Ptr("000-000-0000"),
	// 			PostalCode: to.Ptr("00000"),
	// 			Region: to.Ptr("WA"),
	// 		},
	// 		Status: to.Ptr(armbilling.BillingProfileStatusActive),
	// 		SystemID: to.Ptr("11111111-1111-1111-1111-111111111111"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { BillingManagementClient } = require("@azure/arm-billing");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. If you are a MCA Individual (Pay-as-you-go) customer, then please use the Azure portal experience to create the billing profile.
 *
 * @summary Creates or updates a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. If you are a MCA Individual (Pay-as-you-go) customer, then please use the Azure portal experience to create the billing profile.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesCreateOrUpdate.json
 */
async function billingProfilesCreateOrUpdate() {
  const billingAccountName =
    "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
  const billingProfileName = "xxxx-xxxx-xxx-xxx";
  const parameters = {
    properties: {
      billTo: {
        addressLine1: "Test Address1",
        addressLine2: "Test Address2",
        addressLine3: "Test Address3",
        city: "City",
        companyName: "Contoso",
        country: "US",
        email: "abc@contoso.com",
        firstName: "Test",
        isValidAddress: true,
        lastName: "User",
        phoneNumber: "000-000-0000",
        postalCode: "00000",
        region: "WA",
      },
      displayName: "Billing Profile 1",
      enabledAzurePlans: [{ skuId: "0001" }, { skuId: "0002" }],
      invoiceEmailOptIn: true,
      poNumber: "ABC12345",
      shipTo: {
        addressLine1: "Test Address1",
        addressLine2: "Test Address2",
        addressLine3: "Test Address3",
        city: "City",
        companyName: "Contoso",
        country: "US",
        email: "abc@contoso.com",
        firstName: "Test",
        isValidAddress: true,
        lastName: "User",
        phoneNumber: "000-000-0000",
        postalCode: "00000",
        region: "WA",
      },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const result = await client.billingProfiles.beginCreateOrUpdateAndWait(
    billingAccountName,
    billingProfileName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Billing.Models;
using Azure.ResourceManager.Billing;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingProfilesCreateOrUpdate.json
// this example is just showing the usage of "BillingProfiles_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this BillingAccountResource created on azure
// for more information of creating BillingAccountResource, please refer to the document of BillingAccountResource
string billingAccountName = "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
ResourceIdentifier billingAccountResourceId = BillingAccountResource.CreateResourceIdentifier(billingAccountName);
BillingAccountResource billingAccount = client.GetBillingAccountResource(billingAccountResourceId);

// get the collection of this BillingProfileResource
BillingProfileCollection collection = billingAccount.GetBillingProfiles();

// invoke the operation
string billingProfileName = "xxxx-xxxx-xxx-xxx";
BillingProfileData data = new BillingProfileData
{
    Properties = new BillingProfileProperties
    {
        BillTo = new BillingAddressDetails("Test Address1", "US")
        {
            AddressLine2 = "Test Address2",
            AddressLine3 = "Test Address3",
            City = "City",
            CompanyName = "Contoso",
            Email = "abc@contoso.com",
            FirstName = "Test",
            LastName = "User",
            PhoneNumber = "000-000-0000",
            PostalCode = "00000",
            Region = "WA",
            IsValidAddress = true,
        },
        DisplayName = "Billing Profile 1",
        EnabledAzurePlans = {new BillingAzurePlan
        {
        SkuId = "0001",
        }, new BillingAzurePlan
        {
        SkuId = "0002",
        }},
        IsInvoiceEmailOptIn = true,
        PoNumber = "ABC12345",
        ShipTo = new BillingAddressDetails("Test Address1", "US")
        {
            AddressLine2 = "Test Address2",
            AddressLine3 = "Test Address3",
            City = "City",
            CompanyName = "Contoso",
            Email = "abc@contoso.com",
            FirstName = "Test",
            LastName = "User",
            PhoneNumber = "000-000-0000",
            PostalCode = "00000",
            Region = "WA",
            IsValidAddress = true,
        },
    },
};
ArmOperation<BillingProfileResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, billingProfileName, data);
BillingProfileResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
BillingProfileData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx",
  "name": "xxxx-xxxx-xxx-xxx",
  "properties": {
    "billTo": {
      "addressLine1": "Test Address1",
      "addressLine2": "Test Address2",
      "addressLine3": "Test Address3",
      "city": "City",
      "companyName": "Contoso",
      "country": "US",
      "email": "abc@contoso.com",
      "firstName": "Test",
      "lastName": "User",
      "phoneNumber": "000-000-0000",
      "postalCode": "00000",
      "region": "WA",
      "isValidAddress": true
    },
    "currency": "USD",
    "displayName": "Billing Profile 1",
    "hasReadAccess": true,
    "invoiceDay": 5,
    "invoiceEmailOptIn": true,
    "poNumber": "ABC12345",
    "shipTo": {
      "addressLine1": "Test Address1",
      "addressLine2": "Test Address2",
      "addressLine3": "Test Address3",
      "city": "City",
      "companyName": "Contoso",
      "country": "US",
      "email": "abc@contoso.com",
      "firstName": "Test",
      "lastName": "User",
      "phoneNumber": "000-000-0000",
      "postalCode": "00000",
      "region": "WA",
      "isValidAddress": true
    },
    "status": "Active",
    "systemId": "11111111-1111-1111-1111-111111111111"
  },
  "type": "Microsoft.Billing/billingAccounts/billingProfiles"
}

Status code:

201

{
  "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx",
  "name": "xxxx-xxxx-xxx-xxx",
  "properties": {
    "billTo": {
      "addressLine1": "Test Address1",
      "addressLine2": "Test Address2",
      "addressLine3": "Test Address3",
      "city": "City",
      "companyName": "Contoso",
      "country": "US",
      "email": "abc@contoso.com",
      "firstName": "Test",
      "lastName": "User",
      "phoneNumber": "000-000-0000",
      "postalCode": "00000",
      "region": "WA",
      "isValidAddress": true
    },
    "currency": "USD",
    "displayName": "Billing Profile 1",
    "hasReadAccess": true,
    "invoiceDay": 5,
    "invoiceEmailOptIn": true,
    "poNumber": "ABC12345",
    "shipTo": {
      "addressLine1": "Test Address1",
      "addressLine2": "Test Address2",
      "addressLine3": "Test Address3",
      "city": "City",
      "companyName": "Contoso",
      "country": "US",
      "email": "abc@contoso.com",
      "firstName": "Test",
      "lastName": "User",
      "phoneNumber": "000-000-0000",
      "postalCode": "00000",
      "region": "WA",
      "isValidAddress": true
    },
    "status": "Active",
    "systemId": "11111111-1111-1111-1111-111111111111"
  },
  "type": "Microsoft.Billing/billingAccounts/billingProfiles"
}

Status code:

202

location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/operationResults/putBillingProfile_00000000-0000-0000-0000-000000000000?api-version=2024-04-01
retry-after: 10

Definitions

Name	Description
AzurePlan	Details of the Azure plan.
BillingProfile	A billing profile.
BillingProfileProperties	A billing profile.
BillingProfileStatus	The status of the billing profile.
BillingProfileStatusReasonCode	Reason for the specified billing profile status.
BillingRelationshipType	Identifies the billing relationship represented by the billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party.
BillTo	Billing address.
createdByType	The type of identity that created the resource.
CurrentPaymentTerm	The current payment term of the billing profile.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
IndirectRelationshipInfo	Identifies the billing profile that is linked to another billing profile in indirect purchase motion.
PaymentTerm	The properties of payment term.
ProvisioningState	The provisioning state of the resource during a long-running operation.
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.
SoldTo	The address of the individual or organization that is responsible for the billing account.
SpendingLimit	The billing profile spending limit.
SpendingLimitDetails	The billing profile spending limit.
SpendingLimitStatus	The status of current spending limit.
SpendingLimitType	The type of spending limit.
systemData	Metadata pertaining to creation and last modification of the resource.

AzurePlan

Object

Details of the Azure plan.

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

BillingProfile

Object

A billing profile.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	BillingProfileProperties	A billing profile.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

BillingProfileProperties

Object

A billing profile.

Name	Type	Description
billTo	BillTo	Billing address.
billingRelationshipType	BillingRelationshipType	Identifies the billing relationship represented by the billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party.
currency	string	The currency in which the charges for the billing profile are billed.
currentPaymentTerm	CurrentPaymentTerm	The current payment term of the billing profile.
displayName	string	The name of the billing profile.
enabledAzurePlans	AzurePlan[]	Information about the enabled azure plans.
hasReadAccess	boolean	Indicates whether user has read access to the billing profile.
indirectRelationshipInfo	IndirectRelationshipInfo	Identifies the billing profile that is linked to another billing profile in indirect purchase motion.
invoiceDay	integer (int32)	The day of the month when the invoice for the billing profile is generated.
invoiceEmailOptIn	boolean	Flag controlling whether the invoices for the billing profile are sent through email.
invoiceRecipients	string[]	The list of email addresses to receive invoices by email for the billing profile.
otherPaymentTerms	PaymentTerm[]	The other payment terms of the billing profile.
poNumber	string	The default purchase order number that will appear on the invoices generated for the billing profile.
provisioningState	ProvisioningState	The provisioning state of the resource during a long-running operation.
shipTo	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.
soldTo	SoldTo	The address of the individual or organization that is responsible for the billing account.
spendingLimit	SpendingLimit	The billing profile spending limit.
spendingLimitDetails	SpendingLimitDetails[]	The details of billing profile spending limit.
status	BillingProfileStatus	The status of the billing profile.
statusReasonCode	BillingProfileStatusReasonCode	Reason for the specified billing profile status.
systemId	string	The system generated unique identifier for a billing profile.
tags	object	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 < > % & \ ? /
targetClouds	string[]	Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds.

BillingProfileStatus

Enumeration

The status of the billing profile.

Value	Description
Other
Active
Disabled
Warned
Deleted
UnderReview

BillingProfileStatusReasonCode

Enumeration

Reason for the specified billing profile status.

Value	Description
Other
PastDue
UnusualActivity
SpendingLimitReached
SpendingLimitExpired

BillingRelationshipType

Enumeration

Identifies the billing relationship represented by the billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party.

Value	Description
Other
Direct
IndirectCustomer
IndirectPartner
CSPPartner
CSPCustomer

BillTo

Object

Billing address.

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

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

CurrentPaymentTerm

Object

The current payment term of the billing profile.

Name	Type	Description
endDate	string (date-time)	The date on when the defined 'Payment Term' will end and is always in UTC.
isDefault	boolean	Indicates payment term is the standard payment term.
startDate	string (date-time)	The date on when the defined 'Payment Term' will be effective from and is always in UTC.
term	string	Represents duration in netXX format. Always in days.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

IndirectRelationshipInfo

Object

Identifies the billing profile that is linked to another billing profile in indirect purchase motion.

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

PaymentTerm

Object

The properties of payment term.

Name	Type	Description
endDate	string (date-time)	The date on when the defined 'Payment Term' will end and is always in UTC.
isDefault	boolean	Indicates payment term is the standard payment term.
startDate	string (date-time)	The date on when the defined 'Payment Term' will be effective from and is always in UTC.
term	string	Represents duration in netXX format. Always in days.

ProvisioningState

Enumeration

The provisioning state of the resource during a long-running operation.

Value	Description
Succeeded
Canceled
Failed
New
Pending
Provisioning

ShipTo

Object

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.

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

SoldTo

Object

The address of the individual or organization that is responsible for the billing account.

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

SpendingLimit

Enumeration

The billing profile spending limit.

Value	Description
Off
On

SpendingLimitDetails

Object

The billing profile spending limit.

Name	Type	Description
amount	number	The initial amount for the billing profile.
currency	string	The currency in which the charges for the billing profile are billed.
endDate	string (date-time)	The date when this spending limit is no longer in effect.
startDate	string (date-time)	The date when this spending limit goes into effect.
status	SpendingLimitStatus	The status of current spending limit.
type	SpendingLimitType	The type of spending limit.

SpendingLimitStatus

Enumeration

The status of current spending limit.

Value	Description
Other
None
Active
Expired
LimitReached
LimitRemoved

SpendingLimitType

Enumeration

The type of spending limit.

Value	Description
Other
None
FreeAccount
Sandbox
AzureForStudents
AcademicSponsorship
AzureConsumptionCredit
AzurePassSponsorship
MpnSponsorship
MSDN
NonProfitSponsorship
Sponsorship
StartupSponsorship
AzureForStudentsStarter
VisualStudio

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.