Products - List By Customer

Reference

Service:: Billing

API Version:: 2020-05-01

Lists the products for a customer. These don't include products billed based on usage.The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/products?api-version=2020-05-01

URI Parameters

Name	In	Required	Type	Description
billingAccountName	path	True	string	The ID that uniquely identifies a billing account.
customerName	path	True	string	The ID that uniquely identifies a customer.
api-version	query	True	string	The version of the API to be used with the client request. The current version is 2020-05-01.

Responses

Name	Type	Description
200 OK	ProductsListResult	OK. The request has succeeded.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ProductsListByInvoiceSection

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/products?api-version=2020-05-01

/** Samples for Products ListByCustomer. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByCustomer.json
     */
    /**
     * Sample code: ProductsListByInvoiceSection.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void productsListByInvoiceSection(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.products().listByCustomer("{billingAccountName}", "{customerName}", 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

from azure.identity import DefaultAzureCredential
from azure.mgmt.billing import BillingManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python products_list_by_invoice_section.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.products.list_by_customer(
        billing_account_name="{billingAccountName}",
        customer_name="{customerName}",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByCustomer.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

package armbilling_test

import (
	"context"
	"log"

	"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/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByCustomer.json
func ExampleProductsClient_NewListByCustomerPager() {
	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)
	}
	pager := clientFactory.NewProductsClient().NewListByCustomerPager("{billingAccountName}", "{customerName}", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ProductsListResult = armbilling.ProductsListResult{
		// 	TotalCount: to.Ptr[int32](2),
		// 	Value: []*armbilling.Product{
		// 		{
		// 			Name: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/products"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/00000000-0000-0000-0000-000000000000"),
		// 			Properties: &armbilling.ProductProperties{
		// 				AutoRenew: to.Ptr(armbilling.AutoRenewOn),
		// 				AvailabilityID: to.Ptr("AvailabilityId1"),
		// 				BillingFrequency: to.Ptr(armbilling.BillingFrequencyOneTime),
		// 				BillingProfileDisplayName: to.Ptr("Contoso operations billing"),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000"),
		// 				CustomerDisplayName: to.Ptr("Customer 1"),
		// 				CustomerID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}"),
		// 				DisplayName: to.Ptr("Eng Reservation (1a13s21awe)"),
		// 				LastCharge: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](5000),
		// 				},
		// 				LastChargeDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-15T17:32:28.000Z"); return t}()),
		// 				ProductType: to.Ptr("Reservation"),
		// 				ProductTypeID: to.Ptr("A12345"),
		// 				PurchaseDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-05-01T17:32:28.000Z"); return t}()),
		// 				Quantity: to.Ptr[float32](4),
		// 				Reseller: &armbilling.Reseller{
		// 					Description: to.Ptr("Reseller1"),
		// 					ResellerID: to.Ptr("2c917292-b7bc-42f2-99a2-e498b9087c06"),
		// 				},
		// 				SKUDescription: to.Ptr("Enterprise Agreement Development"),
		// 				SKUID: to.Ptr("0001"),
		// 				Status: to.Ptr(armbilling.ProductStatusTypeActive),
		// 				TenantID: to.Ptr("515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("10000000-0000-0000-0000-000000000001"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/products"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/10000000-0000-0000-0000-000000000001"),
		// 			Properties: &armbilling.ProductProperties{
		// 				AutoRenew: to.Ptr(armbilling.AutoRenewOn),
		// 				AvailabilityID: to.Ptr("AvailabilityId1"),
		// 				BillingFrequency: to.Ptr(armbilling.BillingFrequencyMonthly),
		// 				BillingProfileDisplayName: to.Ptr("Contoso operations billing"),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000"),
		// 				CustomerDisplayName: to.Ptr("Customer 1"),
		// 				CustomerID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}"),
		// 				DisplayName: to.Ptr("Engineering Email"),
		// 				LastCharge: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](500),
		// 				},
		// 				LastChargeDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-15T17:32:28.000Z"); return t}()),
		// 				ProductType: to.Ptr("Azure subscription"),
		// 				ProductTypeID: to.Ptr("A12345"),
		// 				PurchaseDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-01T17:32:28.000Z"); return t}()),
		// 				Quantity: to.Ptr[float32](4),
		// 				SKUDescription: to.Ptr("Enterprise Agreement Development"),
		// 				SKUID: to.Ptr("0001"),
		// 				Status: to.Ptr(armbilling.ProductStatusTypeActive),
		// 				TenantID: to.Ptr("515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce"),
		// 			},
		// 	}},
		// }
	}
}

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

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

/**
 * This sample demonstrates how to Lists the products for a customer. These don't include products billed based on usage.The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
 *
 * @summary Lists the products for a customer. These don't include products billed based on usage.The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByCustomer.json
 */
async function productsListByInvoiceSection() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const billingAccountName = "{billingAccountName}";
  const customerName = "{customerName}";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.products.listByCustomer(billingAccountName, customerName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

productsListByInvoiceSection().catch(console.error);

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

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/00000000-0000-0000-0000-000000000000",
      "name": "00000000-0000-0000-0000-000000000000",
      "type": "Microsoft.Billing/billingAccounts/products",
      "properties": {
        "autoRenew": "On",
        "productTypeId": "A12345",
        "productType": "Reservation",
        "displayName": "Eng Reservation (1a13s21awe)",
        "status": "Active",
        "purchaseDate": "2018-05-01T17:32:28Z",
        "lastCharge": {
          "currency": "USD",
          "value": 5000
        },
        "lastChargeDate": "2018-06-15T17:32:28Z",
        "billingFrequency": "OneTime",
        "quantity": 4,
        "skuId": "0001",
        "skuDescription": "Enterprise Agreement Development",
        "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce",
        "availabilityId": "AvailabilityId1",
        "customerId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}",
        "customerDisplayName": "Customer 1",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
        "billingProfileDisplayName": "Contoso operations billing",
        "reseller": {
          "resellerId": "2c917292-b7bc-42f2-99a2-e498b9087c06",
          "description": "Reseller1"
        }
      }
    },
    {
      "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/10000000-0000-0000-0000-000000000001",
      "name": "10000000-0000-0000-0000-000000000001",
      "type": "Microsoft.Billing/billingAccounts/products",
      "properties": {
        "autoRenew": "On",
        "productTypeId": "A12345",
        "productType": "Azure subscription",
        "displayName": "Engineering Email",
        "status": "Active",
        "purchaseDate": "2018-04-01T17:32:28Z",
        "lastCharge": {
          "currency": "USD",
          "value": 500
        },
        "lastChargeDate": "2018-06-15T17:32:28Z",
        "billingFrequency": "Monthly",
        "quantity": 4,
        "skuId": "0001",
        "skuDescription": "Enterprise Agreement Development",
        "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce",
        "availabilityId": "AvailabilityId1",
        "customerId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}",
        "customerDisplayName": "Customer 1",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
        "billingProfileDisplayName": "Contoso operations billing"
      }
    }
  ],
  "totalCount": 2
}

Definitions

Name	Description
Amount	The amount.
AutoRenew	Indicates whether auto renewal is turned on or off for a product.
BillingFrequency	The frequency at which the product will be billed.
ErrorDetails	The details of the error.
ErrorResponse	Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
ErrorSubDetails
Product	A product.
ProductsListResult	The list of products. It contains a list of available product summaries in reverse chronological order by purchase date.
ProductStatusType	The current status of the product.
Reseller	Details of the reseller.

Amount

The amount.

Name	Type	Description
currency	string	The currency for the amount value.
value	number	Amount value.

AutoRenew

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

Name	Type	Description
Off	string
On	string

BillingFrequency

The frequency at which the product will be billed.

Name	Type	Description
Monthly	string
OneTime	string
UsageBased	string

ErrorDetails

The details of the error.

Name	Type	Description
code	string	Error code.
details	ErrorSubDetails[]	The sub details of the error.
message	string	Error message indicating why the operation failed.
target	string	The target of the particular error.

ErrorResponse

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Name	Type	Description
error	ErrorDetails	The details of the error.

ErrorSubDetails

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.
target	string	The target of the particular error.

Product

A product.

Name	Type	Description
id	string	Resource Id.
name	string	Resource name.
properties.autoRenew	AutoRenew	Indicates whether auto renewal is turned on or off for a product.
properties.availabilityId	string	The availability of the product.
properties.billingFrequency	BillingFrequency	The frequency at which the product will be billed.
properties.billingProfileDisplayName	string	The name of the billing profile to which the product is billed.
properties.billingProfileId	string	The ID of the billing profile to which the product is billed.
properties.customerDisplayName	string	The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account.
properties.customerId	string	The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account.
properties.displayName	string	The display name of the product.
properties.endDate	string	The date when the product will be renewed or canceled.
properties.invoiceSectionDisplayName	string	The name of the invoice section to which the product is billed.
properties.invoiceSectionId	string	The ID of the invoice section to which the product is billed.
properties.lastCharge	Amount	The last month charges.
properties.lastChargeDate	string	The date of the last charge.
properties.productType	string	The description of the type of product.
properties.productTypeId	string	The ID of the type of product.
properties.purchaseDate	string	The date when the product was purchased.
properties.quantity	number	The quantity purchased for the product.
properties.reseller	Reseller	Reseller for this product.
properties.skuDescription	string	The sku description of the product.
properties.skuId	string	The sku ID of the product.
properties.status	ProductStatusType	The current status of the product.
properties.tenantId	string	The id of the tenant in which the product is used.
type	string	Resource type.

ProductsListResult

The list of products. It contains a list of available product summaries in reverse chronological order by purchase date.

Name	Type	Description
nextLink	string	The link (url) to the next page of results.
totalCount	number	Total number of records.
value	Product[]	The list of products.

ProductStatusType

The current status of the product.

Name	Type	Description
Active	string
AutoRenew	string
Cancelled	string
Disabled	string
Expired	string
Expiring	string
Inactive	string
PastDue	string

Reseller

Details of the reseller.

Name	Type	Description
description	string	The name of the reseller.
resellerId	string	The MPN ID of the reseller.

Products - List By Customer

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

ProductsListByInvoiceSection

Sample Request

Sample Response

Definitions

Amount

AutoRenew

BillingFrequency

ErrorDetails

ErrorResponse

ErrorSubDetails

Product

ProductsListResult

ProductStatusType

Reseller

Ressources supplémentaires