Billing Subscriptions - List By Customer

Referens

Service:: Billing

API Version:: 2020-05-01

Visar en lista över prenumerationer för en kund. Åtgärden stöds endast för faktureringskonton med avtalstyp Microsoft-partneravtal.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
billingAccountName	path	True	string	Det ID som unikt identifierar ett faktureringskonto.
customerName	path	True	string	Det ID som unikt identifierar en kund.
api-version	query	True	string	Den version av API:et som ska användas med klientbegäran. Den aktuella versionen är 2020-05-01.

Svar

Name	Typ	Description
200 OK	BillingSubscriptionsListResult	OK. Begäran har slutförts.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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	personifiera ditt användarkonto

Exempel

BillingSubscriptionsListByCustomer

Sample Request

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

/** Samples for BillingSubscriptions ListByCustomer. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByCustomer.json
     */
    /**
     * Sample code: BillingSubscriptionsListByCustomer.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void billingSubscriptionsListByCustomer(com.azure.resourcemanager.billing.BillingManager manager) {
        manager
            .billingSubscriptions()
            .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 billing_subscriptions_list_by_customer.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_subscriptions.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/BillingSubscriptionsListByCustomer.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/BillingSubscriptionsListByCustomer.json
func ExampleSubscriptionsClient_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.NewSubscriptionsClient().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.SubscriptionsListResult = armbilling.SubscriptionsListResult{
		// 	Value: []*armbilling.Subscription{
		// 		{
		// 			Name: to.Ptr("billingSubscriptionId1"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/billingSubscriptions"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId1"),
		// 			Properties: &armbilling.SubscriptionProperties{
		// 				CostCenter: to.Ptr("ABC1234"),
		// 				CustomerDisplayName: to.Ptr("Customer1"),
		// 				CustomerID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}"),
		// 				DisplayName: to.Ptr("My subscription"),
		// 				LastMonthCharges: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](5000),
		// 				},
		// 				MonthToDateCharges: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](600),
		// 				},
		// 				Reseller: &armbilling.Reseller{
		// 					Description: to.Ptr("Reseller1"),
		// 					ResellerID: to.Ptr("89e87bdf-a2a2-4687-925f-4c18b27bccfd"),
		// 				},
		// 				SKUDescription: to.Ptr("Microsoft Azure Plan for DevTest"),
		// 				SKUID: to.Ptr("0002"),
		// 				SubscriptionBillingStatus: to.Ptr(armbilling.BillingSubscriptionStatusTypeActive),
		// 				SubscriptionID: to.Ptr("6b96d3f2-9008-4a9d-912f-f87744185aa3"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("billingSubscriptionId2"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/billingSubscriptions"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId2"),
		// 			Properties: &armbilling.SubscriptionProperties{
		// 				CostCenter: to.Ptr("ABC1234"),
		// 				CustomerDisplayName: to.Ptr("Customer1"),
		// 				CustomerID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}"),
		// 				DisplayName: to.Ptr("Test subscription"),
		// 				LastMonthCharges: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](1000),
		// 				},
		// 				MonthToDateCharges: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](400),
		// 				},
		// 				Reseller: &armbilling.Reseller{
		// 					Description: to.Ptr("Reseller3"),
		// 					ResellerID: to.Ptr("3b65b5a8-bd4f-4084-90e9-e1bd667a2b19"),
		// 				},
		// 				SKUDescription: to.Ptr("Microsoft Azure Plan for DevTest"),
		// 				SKUID: to.Ptr("0002"),
		// 				SubscriptionBillingStatus: to.Ptr(armbilling.BillingSubscriptionStatusTypeActive),
		// 				SubscriptionID: to.Ptr("6b96d3f2-9008-4a9d-912f-6b96d3f2"),
		// 			},
		// 	}},
		// }
	}
}

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 subscriptions for a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
 *
 * @summary Lists the subscriptions for a customer. 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/BillingSubscriptionsListByCustomer.json
 */
async function billingSubscriptionsListByCustomer() {
  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.billingSubscriptions.listByCustomer(
    billingAccountName,
    customerName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

billingSubscriptionsListByCustomer().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}/billingSubscriptions/billinSubscriptionId1",
      "name": "billingSubscriptionId1",
      "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
      "properties": {
        "displayName": "My subscription",
        "subscriptionId": "87607149-63a6-4644-8dc1-1d2e368f4994",
        "subscriptionBillingStatus": "Active",
        "lastMonthCharges": {
          "currency": "USD",
          "value": 5000
        },
        "monthToDateCharges": {
          "currency": "USD",
          "value": 600
        },
        "costCenter": "ABC1234",
        "customerId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}",
        "customerDisplayName": "Customer1",
        "reseller": {
          "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd",
          "description": "Reseller1"
        },
        "skuId": "0002",
        "skuDescription": "Microsoft Azure Plan for DevTest"
      }
    },
    {
      "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId2",
      "name": "billingSubscriptionId2",
      "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
      "properties": {
        "displayName": "Test subscription",
        "subscriptionId": "87607149-63a6-4644-8dc1-1d2e368f4995",
        "subscriptionBillingStatus": "Active",
        "lastMonthCharges": {
          "currency": "USD",
          "value": 1000
        },
        "monthToDateCharges": {
          "currency": "USD",
          "value": 400
        },
        "costCenter": "ABC1234",
        "customerId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}",
        "customerDisplayName": "Customer1",
        "reseller": {
          "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19",
          "description": "Reseller3"
        },
        "skuId": "0002",
        "skuDescription": "Microsoft Azure Plan for DevTest"
      }
    }
  ]
}

Definitioner

Name	Description
Amount	Beloppet.
BillingSubscription	En faktureringsprenumeration.
BillingSubscriptionsListResult	Listan över faktureringsprenumerationer.
BillingSubscriptionStatusType	Prenumerationens aktuella faktureringsstatus.
ErrorDetails	Information om felet.
ErrorResponse	Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.
ErrorSubDetails
Reseller	Information om återförsäljaren.

Amount

Beloppet.

Name	Typ	Description
currency	string	Valutan för beloppsvärdet.
value	number	Beloppsvärde.

BillingSubscription

En faktureringsprenumeration.

Name	Typ	Description
id	string	Resurs-ID.
name	string	Resursnamn.
properties.billingProfileDisplayName	string	Namnet på den faktureringsprofil som prenumerationen faktureras till.
properties.billingProfileId	string	ID:t för den faktureringsprofil som prenumerationen faktureras till.
properties.costCenter	string	Kostnadsställe som tillämpas på prenumerationen.
properties.customerDisplayName	string	Namnet på kunden som prenumerationen skapades för. Fältet gäller endast för Microsoft-partneravtal faktureringskonto.
properties.customerId	string	ID för kunden som prenumerationen skapades för. Fältet gäller endast för Microsoft-partneravtal faktureringskonto.
properties.displayName	string	Namnet på prenumerationen.
properties.invoiceSectionDisplayName	string	Namnet på fakturaavsnittet som prenumerationen faktureras till.
properties.invoiceSectionId	string	ID:t för fakturaavsnittet som prenumerationen faktureras till.
properties.lastMonthCharges	Amount	Den senaste månadens avgifter.
properties.monthToDateCharges	Amount	Aktuell månad hittills avgifter.
properties.reseller	Reseller	Återförsäljare för den här prenumerationen.
properties.skuDescription	string	SKU-beskrivningen av Azure-planen för prenumerationen.
properties.skuId	string	SKU-ID för Azure-planen för prenumerationen.
properties.subscriptionBillingStatus	BillingSubscriptionStatusType	Prenumerationens aktuella faktureringsstatus.
properties.subscriptionId	string	ID för prenumerationen.
properties.suspensionReasons	string[]	Avstängningsorsaken till en prenumeration. Gäller endast för prenumerationer i Faktureringskonton för Microsoft Online Services Program.
type	string	Resurstyp.

BillingSubscriptionsListResult

Listan över faktureringsprenumerationer.

Name	Typ	Description
nextLink	string	Länken (url) till nästa sida med resultat.
totalCount	number	Totalt antal poster.
value	BillingSubscription[]	Listan över faktureringsprenumerationer.

BillingSubscriptionStatusType

Prenumerationens aktuella faktureringsstatus.

Name	Typ	Description
Abandoned	string
Active	string
Deleted	string
Inactive	string
Warning	string

ErrorDetails

Information om felet.

Name	Typ	Description
code	string	Felkod.
details	ErrorSubDetails[]	Underinformationen om felet.
message	string	Felmeddelande som anger varför åtgärden misslyckades.
target	string	Målet för det specifika felet.

ErrorResponse

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Name	Typ	Description
error	ErrorDetails	Information om felet.

ErrorSubDetails

Name	Typ	Description
code	string	Felkod.
message	string	Felmeddelande som anger varför åtgärden misslyckades.
target	string	Målet för det specifika felet.

Reseller

Information om återförsäljaren.

Name	Typ	Description
description	string	Namnet på återförsäljaren.
resellerId	string	MPN-ID för återförsäljaren.

Billing Subscriptions - List By Customer

URI-parametrar

Svar

Säkerhet

azure_auth

Scopes

Exempel

BillingSubscriptionsListByCustomer

Sample Request

Sample Response

Definitioner

Amount

BillingSubscription

BillingSubscriptionsListResult

BillingSubscriptionStatusType

ErrorDetails

ErrorResponse

ErrorSubDetails

Reseller

Ytterligare resurser