Savings Plans - List By Billing Account

Service:

Billing

API Version:

2024-04-01

List savings plans by billing account.

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

With optional parameters:

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlans?api-version=2024-04-01&filter={filter}&orderBy={orderBy}&skiptoken={skiptoken}&take={take}&selectedState={selectedState}&refreshSummary={refreshSummary}

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.
api-version	query	True	string	The version of the API to be used with the client request. The current version is 2024-04-01.
filter	query		string	The filter query option allows clients to filter a collection of resources that are addressed by a request URL.
orderBy	query		string	The orderby query option allows clients to request resources in a particular order.
refreshSummary	query		string	To indicate whether to refresh the roll up counts of the savings plans group by provisioning states
selectedState	query		string	The selected provisioning state
skiptoken	query		number	The number of savings plans to skip from the list before returning results
take	query		number	The number of savings plans to return

Responses

Name	Type	Description
200 OK	SavingsPlanModelListResult	The request is completed.
Other Status Codes	ErrorResponse	Unexpected error.

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

SavingsPlansList

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlans?api-version=2024-04-01&take=3&selectedState=Succeeded&refreshSummary=true

Java

/**
 * Samples for SavingsPlans ListByBillingAccount.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
     * savingsPlansListByBillingAccount.json
     */
    /**
     * Sample code: SavingsPlansList.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void savingsPlansList(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.savingsPlans().listByBillingAccount(
            "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", null, null, null,
            3.0F, "Succeeded", "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 savings_plans_list_by_billing_account.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.savings_plans.list_by_billing_account(
        billing_account_name="00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlansListByBillingAccount.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/savingsPlansListByBillingAccount.json
func ExampleSavingsPlansClient_NewListByBillingAccountPager() {
	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.NewSavingsPlansClient().NewListByBillingAccountPager("00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", &armbilling.SavingsPlansClientListByBillingAccountOptions{Filter: nil,
		OrderBy:        nil,
		Skiptoken:      nil,
		Take:           to.Ptr[float32](3),
		SelectedState:  to.Ptr("Succeeded"),
		RefreshSummary: to.Ptr("true"),
	})
	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.SavingsPlanModelListResult = armbilling.SavingsPlanModelListResult{
		// 	Value: []*armbilling.SavingsPlanModel{
		// 		{
		// 			Name: to.Ptr("30000000-0000-0000-0000-000000000000"),
		// 			Type: to.Ptr("microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("value1"),
		// 				"key2": to.Ptr("value2"),
		// 			},
		// 			Properties: &armbilling.SavingsPlanModelProperties{
		// 				AppliedScopeType: to.Ptr(armbilling.AppliedScopeTypeShared),
		// 				BenefitStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-12-16T02:17:03.739Z"); return t}()),
		// 				BillingAccountID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
		// 				BillingPlan: to.Ptr(armbilling.BillingPlanP1M),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD"),
		// 				BillingScopeID: to.Ptr("/subscriptions/10000000-0000-0000-0000-000000000000"),
		// 				Commitment: &armbilling.Commitment{
		// 					Amount: to.Ptr[float64](10),
		// 					CurrencyCode: to.Ptr("USD"),
		// 					Grain: to.Ptr(armbilling.CommitmentGrainHourly),
		// 				},
		// 				DisplayName: to.Ptr("SP1"),
		// 				DisplayProvisioningState: to.Ptr("Succeeded"),
		// 				EffectiveDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-12-16T02:17:04.989Z"); return t}()),
		// 				ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-12-16T02:17:03.739Z"); return t}()),
		// 				ProductCode: to.Ptr("20000000-0000-0000-0000-000000000005"),
		// 				ProvisioningState: to.Ptr(armbilling.ProvisioningStateSucceeded),
		// 				PurchaseDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-12-16T02:14:58.230Z"); return t}()),
		// 				Renew: to.Ptr(false),
		// 				Term: to.Ptr(armbilling.SavingsPlanTermP1Y),
		// 				UserFriendlyAppliedScopeType: to.Ptr("Shared"),
		// 				Utilization: &armbilling.Utilization{
		// 					Aggregates: []*armbilling.UtilizationAggregates{
		// 						{
		// 							Grain: to.Ptr[float32](1),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](0),
		// 							ValueUnit: to.Ptr("percentage"),
		// 						},
		// 						{
		// 							Grain: to.Ptr[float32](7),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](0),
		// 							ValueUnit: to.Ptr("percentage"),
		// 						},
		// 						{
		// 							Grain: to.Ptr[float32](30),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](0),
		// 							ValueUnit: to.Ptr("percentage"),
		// 					}},
		// 					Trend: to.Ptr("SAME"),
		// 				},
		// 			},
		// 			SKU: &armbilling.SKU{
		// 				Name: to.Ptr("Compute_Savings_Plan"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("30000000-0000-0000-0000-000000000001"),
		// 			Type: to.Ptr("microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000001/savingsPlans/30000000-0000-0000-0000-000000000001"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("value1"),
		// 				"key2": to.Ptr("value2"),
		// 			},
		// 			Properties: &armbilling.SavingsPlanModelProperties{
		// 				AppliedScopeProperties: &armbilling.AppliedScopeProperties{
		// 					DisplayName: to.Ptr("TestRg"),
		// 					ManagementGroupID: to.Ptr("/providers/Microsoft.Management/managementGroups/TestRg"),
		// 					TenantID: to.Ptr("50000000-0000-0000-0000-000000000000"),
		// 				},
		// 				AppliedScopeType: to.Ptr(armbilling.AppliedScopeTypeManagementGroup),
		// 				BenefitStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-12-16T02:22:22.725Z"); return t}()),
		// 				BillingAccountID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
		// 				BillingPlan: to.Ptr(armbilling.BillingPlanP1M),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD"),
		// 				BillingScopeID: to.Ptr("/subscriptions/10000000-0000-0000-0000-000000000000"),
		// 				Commitment: &armbilling.Commitment{
		// 					Amount: to.Ptr[float64](10),
		// 					CurrencyCode: to.Ptr("USD"),
		// 					Grain: to.Ptr(armbilling.CommitmentGrainHourly),
		// 				},
		// 				DisplayName: to.Ptr("SP2"),
		// 				DisplayProvisioningState: to.Ptr("Succeeded"),
		// 				EffectiveDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-12-16T02:22:24.553Z"); return t}()),
		// 				ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-12-16T02:22:22.725Z"); return t}()),
		// 				ProductCode: to.Ptr("20000000-0000-0000-0000-000000000005"),
		// 				ProvisioningState: to.Ptr(armbilling.ProvisioningStateSucceeded),
		// 				PurchaseDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-12-16T02:20:23.473Z"); return t}()),
		// 				Renew: to.Ptr(false),
		// 				Term: to.Ptr(armbilling.SavingsPlanTermP1Y),
		// 				UserFriendlyAppliedScopeType: to.Ptr("ManagementGroup"),
		// 				Utilization: &armbilling.Utilization{
		// 					Aggregates: []*armbilling.UtilizationAggregates{
		// 						{
		// 							Grain: to.Ptr[float32](1),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](0),
		// 							ValueUnit: to.Ptr("percentage"),
		// 						},
		// 						{
		// 							Grain: to.Ptr[float32](7),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](0),
		// 							ValueUnit: to.Ptr("percentage"),
		// 						},
		// 						{
		// 							Grain: to.Ptr[float32](30),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](0),
		// 							ValueUnit: to.Ptr("percentage"),
		// 					}},
		// 					Trend: to.Ptr("SAME"),
		// 				},
		// 			},
		// 			SKU: &armbilling.SKU{
		// 				Name: to.Ptr("Compute_Savings_Plan"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("30000000-0000-0000-0000-000000000002"),
		// 			Type: to.Ptr("microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000002/savingsPlans/30000000-0000-0000-0000-000000000002"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("value1"),
		// 				"key2": to.Ptr("value2"),
		// 			},
		// 			Properties: &armbilling.SavingsPlanModelProperties{
		// 				AppliedScopeProperties: &armbilling.AppliedScopeProperties{
		// 					DisplayName: to.Ptr("Azure subscription 1"),
		// 					SubscriptionID: to.Ptr("/subscriptions/10000000-0000-0000-0000-000000000000"),
		// 				},
		// 				AppliedScopeType: to.Ptr(armbilling.AppliedScopeTypeSingle),
		// 				BenefitStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-14T21:18:55.296Z"); return t}()),
		// 				BillingAccountID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
		// 				BillingPlan: to.Ptr(armbilling.BillingPlanP1M),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD"),
		// 				BillingScopeID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/10000000-0000-0000-0000-000000000000"),
		// 				Commitment: &armbilling.Commitment{
		// 					Amount: to.Ptr[float64](0.025),
		// 					CurrencyCode: to.Ptr("USD"),
		// 					Grain: to.Ptr(armbilling.CommitmentGrainHourly),
		// 				},
		// 				DisplayName: to.Ptr("SP3"),
		// 				DisplayProvisioningState: to.Ptr("Succeeded"),
		// 				EffectiveDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-07T23:54:43.823Z"); return t}()),
		// 				ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-10-14T21:18:55.296Z"); return t}()),
		// 				ProductCode: to.Ptr("20000000-0000-0000-0000-000000000005"),
		// 				ProvisioningState: to.Ptr(armbilling.ProvisioningStateSucceeded),
		// 				PurchaseDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-14T21:16:57.234Z"); return t}()),
		// 				Renew: to.Ptr(true),
		// 				Term: to.Ptr(armbilling.SavingsPlanTermP3Y),
		// 				UserFriendlyAppliedScopeType: to.Ptr("Single"),
		// 				Utilization: &armbilling.Utilization{
		// 					Aggregates: []*armbilling.UtilizationAggregates{
		// 						{
		// 							Grain: to.Ptr[float32](1),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](66),
		// 							ValueUnit: to.Ptr("percentage"),
		// 						},
		// 						{
		// 							Grain: to.Ptr[float32](7),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](66),
		// 							ValueUnit: to.Ptr("percentage"),
		// 						},
		// 						{
		// 							Grain: to.Ptr[float32](30),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](65.52),
		// 							ValueUnit: to.Ptr("percentage"),
		// 					}},
		// 					Trend: to.Ptr("SAME"),
		// 				},
		// 			},
		// 			SKU: &armbilling.SKU{
		// 				Name: to.Ptr("Compute_Savings_Plan"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("30000000-0000-0000-0000-000000000003"),
		// 			Type: to.Ptr("microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000003/savingsPlans/30000000-0000-0000-0000-000000000003"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("value1"),
		// 				"key2": to.Ptr("value2"),
		// 			},
		// 			Properties: &armbilling.SavingsPlanModelProperties{
		// 				AppliedScopeProperties: &armbilling.AppliedScopeProperties{
		// 					DisplayName: to.Ptr("testRG"),
		// 					ResourceGroupID: to.Ptr("/subscriptions/10000000-0000-0000-0000-000000000000/resourcegroups/testRG"),
		// 				},
		// 				AppliedScopeType: to.Ptr(armbilling.AppliedScopeTypeSingle),
		// 				BenefitStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-08T00:00:06.363Z"); return t}()),
		// 				BillingAccountID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
		// 				BillingPlan: to.Ptr(armbilling.BillingPlanP1M),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD"),
		// 				BillingScopeID: to.Ptr("/subscriptions/10000000-0000-0000-0000-000000000000"),
		// 				Commitment: &armbilling.Commitment{
		// 					Amount: to.Ptr[float64](0.001),
		// 					CurrencyCode: to.Ptr("USD"),
		// 					Grain: to.Ptr(armbilling.CommitmentGrainHourly),
		// 				},
		// 				DisplayName: to.Ptr("SP4"),
		// 				DisplayProvisioningState: to.Ptr("Succeeded"),
		// 				EffectiveDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-30T21:18:12.196Z"); return t}()),
		// 				ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-11-08T00:00:06.363Z"); return t}()),
		// 				ProductCode: to.Ptr("20000000-0000-0000-0000-000000000005"),
		// 				ProvisioningState: to.Ptr(armbilling.ProvisioningStateSucceeded),
		// 				PurchaseDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-07T23:57:58.242Z"); return t}()),
		// 				Renew: to.Ptr(false),
		// 				Term: to.Ptr(armbilling.SavingsPlanTermP3Y),
		// 				UserFriendlyAppliedScopeType: to.Ptr("ResourceGroup"),
		// 				Utilization: &armbilling.Utilization{
		// 					Aggregates: []*armbilling.UtilizationAggregates{
		// 						{
		// 							Grain: to.Ptr[float32](1),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](100),
		// 							ValueUnit: to.Ptr("percentage"),
		// 						},
		// 						{
		// 							Grain: to.Ptr[float32](7),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](100),
		// 							ValueUnit: to.Ptr("percentage"),
		// 						},
		// 						{
		// 							Grain: to.Ptr[float32](30),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](100),
		// 							ValueUnit: to.Ptr("percentage"),
		// 					}},
		// 					Trend: to.Ptr("SAME"),
		// 				},
		// 			},
		// 			SKU: &armbilling.SKU{
		// 				Name: to.Ptr("Compute_Savings_Plan"),
		// 			},
		// 	}},
		// 	Summary: &armbilling.SavingsPlanSummaryCount{
		// 		CancelledCount: to.Ptr[float32](0),
		// 		ExpiredCount: to.Ptr[float32](0),
		// 		ExpiringCount: to.Ptr[float32](0),
		// 		FailedCount: to.Ptr[float32](0),
		// 		NoBenefitCount: to.Ptr[float32](0),
		// 		PendingCount: to.Ptr[float32](0),
		// 		ProcessingCount: to.Ptr[float32](0),
		// 		SucceededCount: to.Ptr[float32](3),
		// 		WarningCount: to.Ptr[float32](0),
		// 	},
		// }
	}
}

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 List savings plans by billing account.
 *
 * @summary List savings plans by billing account.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlansListByBillingAccount.json
 */
async function savingsPlansList() {
  const billingAccountName =
    "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
  const take = 3;
  const selectedState = "Succeeded";
  const refreshSummary = "true";
  const options = {
    take,
    selectedState,
    refreshSummary,
  };
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const resArray = new Array();
  for await (let item of client.savingsPlans.listByBillingAccount(billingAccountName, options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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.Collections.Generic;
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/savingsPlansListByBillingAccount.json
// this example is just showing the usage of "SavingsPlans_ListByBillingAccount" 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);

// invoke the operation and iterate over the result
BillingAccountResourceGetByBillingAccountSavingsPlanOptions options = new BillingAccountResourceGetByBillingAccountSavingsPlanOptions { Take = 3, SelectedState = "Succeeded", RefreshSummary = "true" };
await foreach (BillingSavingsPlanModelResource item in billingAccount.GetByBillingAccountSavingsPlanAsync(options))
{
    // the variable item 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
    BillingSavingsPlanModelData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000",
      "name": "30000000-0000-0000-0000-000000000000",
      "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans",
      "sku": {
        "name": "Compute_Savings_Plan"
      },
      "tags": {
        "key1": "value1",
        "key2": "value2"
      },
      "properties": {
        "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000",
        "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD",
        "billingPlan": "P1M",
        "productCode": "20000000-0000-0000-0000-000000000005",
        "commitment": {
          "grain": "Hourly",
          "currencyCode": "USD",
          "amount": 10
        },
        "renew": false,
        "appliedScopeType": "Shared",
        "displayName": "SP1",
        "provisioningState": "Succeeded",
        "term": "P1Y",
        "displayProvisioningState": "Succeeded",
        "userFriendlyAppliedScopeType": "Shared",
        "expiryDateTime": "2023-12-16T02:17:03.7396152Z",
        "purchaseDateTime": "2022-12-16T02:14:58.2304134Z",
        "benefitStartTime": "2022-12-16T02:17:03.7396152Z",
        "effectiveDateTime": "2022-12-16T02:17:04.9896661Z",
        "utilization": {
          "trend": "SAME",
          "aggregates": [
            {
              "grain": 1,
              "grainUnit": "days",
              "value": 0,
              "valueUnit": "percentage"
            },
            {
              "grain": 7,
              "grainUnit": "days",
              "value": 0,
              "valueUnit": "percentage"
            },
            {
              "grain": 30,
              "grainUnit": "days",
              "value": 0,
              "valueUnit": "percentage"
            }
          ]
        }
      }
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000001/savingsPlans/30000000-0000-0000-0000-000000000001",
      "name": "30000000-0000-0000-0000-000000000001",
      "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans",
      "sku": {
        "name": "Compute_Savings_Plan"
      },
      "tags": {
        "key1": "value1",
        "key2": "value2"
      },
      "properties": {
        "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000",
        "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD",
        "billingPlan": "P1M",
        "productCode": "20000000-0000-0000-0000-000000000005",
        "appliedScopeProperties": {
          "tenantId": "50000000-0000-0000-0000-000000000000",
          "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg",
          "displayName": "TestRg"
        },
        "commitment": {
          "grain": "Hourly",
          "currencyCode": "USD",
          "amount": 10
        },
        "renew": false,
        "appliedScopeType": "ManagementGroup",
        "displayName": "SP2",
        "provisioningState": "Succeeded",
        "term": "P1Y",
        "displayProvisioningState": "Succeeded",
        "userFriendlyAppliedScopeType": "ManagementGroup",
        "expiryDateTime": "2023-12-16T02:22:22.7254795Z",
        "purchaseDateTime": "2022-12-16T02:20:23.4733076Z",
        "benefitStartTime": "2022-12-16T02:22:22.7254795Z",
        "effectiveDateTime": "2022-12-16T02:22:24.5536191Z",
        "utilization": {
          "trend": "SAME",
          "aggregates": [
            {
              "grain": 1,
              "grainUnit": "days",
              "value": 0,
              "valueUnit": "percentage"
            },
            {
              "grain": 7,
              "grainUnit": "days",
              "value": 0,
              "valueUnit": "percentage"
            },
            {
              "grain": 30,
              "grainUnit": "days",
              "value": 0,
              "valueUnit": "percentage"
            }
          ]
        }
      }
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000002/savingsPlans/30000000-0000-0000-0000-000000000002",
      "name": "30000000-0000-0000-0000-000000000002",
      "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans",
      "sku": {
        "name": "Compute_Savings_Plan"
      },
      "tags": {
        "key1": "value1",
        "key2": "value2"
      },
      "properties": {
        "billingScopeId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/10000000-0000-0000-0000-000000000000",
        "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD",
        "billingPlan": "P1M",
        "productCode": "20000000-0000-0000-0000-000000000005",
        "appliedScopeProperties": {
          "subscriptionId": "/subscriptions/10000000-0000-0000-0000-000000000000",
          "displayName": "Azure subscription 1"
        },
        "commitment": {
          "grain": "Hourly",
          "currencyCode": "USD",
          "amount": 0.025
        },
        "renew": true,
        "appliedScopeType": "Single",
        "displayName": "SP3",
        "provisioningState": "Succeeded",
        "term": "P3Y",
        "displayProvisioningState": "Succeeded",
        "userFriendlyAppliedScopeType": "Single",
        "expiryDateTime": "2025-10-14T21:18:55.2960613Z",
        "purchaseDateTime": "2022-10-14T21:16:57.2347688Z",
        "benefitStartTime": "2022-10-14T21:18:55.2960613Z",
        "effectiveDateTime": "2022-11-07T23:54:43.8233243Z",
        "utilization": {
          "trend": "SAME",
          "aggregates": [
            {
              "grain": 1,
              "grainUnit": "days",
              "value": 66,
              "valueUnit": "percentage"
            },
            {
              "grain": 7,
              "grainUnit": "days",
              "value": 66,
              "valueUnit": "percentage"
            },
            {
              "grain": 30,
              "grainUnit": "days",
              "value": 65.52,
              "valueUnit": "percentage"
            }
          ]
        }
      }
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000003/savingsPlans/30000000-0000-0000-0000-000000000003",
      "name": "30000000-0000-0000-0000-000000000003",
      "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans",
      "sku": {
        "name": "Compute_Savings_Plan"
      },
      "tags": {
        "key1": "value1",
        "key2": "value2"
      },
      "properties": {
        "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000",
        "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD",
        "billingPlan": "P1M",
        "productCode": "20000000-0000-0000-0000-000000000005",
        "appliedScopeProperties": {
          "resourceGroupId": "/subscriptions/10000000-0000-0000-0000-000000000000/resourcegroups/testRG",
          "displayName": "testRG"
        },
        "commitment": {
          "grain": "Hourly",
          "currencyCode": "USD",
          "amount": 0.001
        },
        "renew": false,
        "appliedScopeType": "Single",
        "displayName": "SP4",
        "provisioningState": "Succeeded",
        "term": "P3Y",
        "displayProvisioningState": "Succeeded",
        "userFriendlyAppliedScopeType": "ResourceGroup",
        "expiryDateTime": "2025-11-08T00:00:06.3636747Z",
        "purchaseDateTime": "2022-11-07T23:57:58.2428677Z",
        "benefitStartTime": "2022-11-08T00:00:06.3636747Z",
        "effectiveDateTime": "2022-11-30T21:18:12.1967323Z",
        "utilization": {
          "trend": "SAME",
          "aggregates": [
            {
              "grain": 1,
              "grainUnit": "days",
              "value": 100,
              "valueUnit": "percentage"
            },
            {
              "grain": 7,
              "grainUnit": "days",
              "value": 100,
              "valueUnit": "percentage"
            },
            {
              "grain": 30,
              "grainUnit": "days",
              "value": 100,
              "valueUnit": "percentage"
            }
          ]
        }
      }
    }
  ],
  "summary": {
    "noBenefitCount": 0,
    "warningCount": 0,
    "succeededCount": 3,
    "failedCount": 0,
    "expiringCount": 0,
    "expiredCount": 0,
    "pendingCount": 0,
    "cancelledCount": 0,
    "processingCount": 0
  }
}

Definitions

Name	Description
AppliedScopeProperties	Properties specific to applied scope type. Not required if not applicable.
AppliedScopeType	Type of the Applied Scope.
BillingPlan	Represents the billing plan in ISO 8601 format. Required only for monthly purchases.
Commitment	Commitment towards the benefit.
CommitmentGrain	Commitment grain.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExtendedStatusInfo	Extended status information
ProvisioningState	Provisioning state
PurchaseRequest	Purchase request.
RenewProperties	Properties specific to renew.
SavingsPlanModel	Savings plan
SavingsPlanModelListResult	List of savings plans
SavingsPlanSummaryCount	The roll up count summary of savings plans in each state
SavingsPlanTerm	Represents the Savings plan term in ISO 8601 format.
Sku	The SKU to be applied for this resource
systemData	Metadata pertaining to creation and last modification of the resource.
Utilization	Savings plan utilization
UtilizationAggregates	The aggregate values of savings plan utilization

AppliedScopeProperties

Object

Properties specific to applied scope type. Not required if not applicable.

Name	Type	Description
displayName	string	Display name
managementGroupId	string	Fully-qualified identifier of the management group where the benefit is applied.
resourceGroupId	string	Fully-qualified identifier of the resource group where the benefit is applied.
subscriptionId	string	Fully-qualified identifier of the subscription where the benefit is applied.
tenantId	string	Tenant ID where the savings plan where the benefit is applied.

AppliedScopeType

Enumeration

Type of the Applied Scope.

Value	Description
Single
Shared
ManagementGroup

BillingPlan

Enumeration

Represents the billing plan in ISO 8601 format. Required only for monthly purchases.

Value	Description
P1M

Commitment

Object

Commitment towards the benefit.

Name	Type	Description
amount	number (double)
currencyCode	string	The ISO 4217 3-letter currency code for the currency used by this purchase record.
grain	CommitmentGrain	Commitment grain.

CommitmentGrain

Enumeration

Commitment grain.

Value	Description
Hourly

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

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.

ExtendedStatusInfo

Object

Extended status information

Name	Type	Description
message	string	The message giving detailed information about the status code.
properties.subscriptionId	string	The subscription that has failed credit line check.
statusCode	string	Status code providing additional information.

ProvisioningState

Enumeration

Provisioning state

Value	Description
PendingBilling
ConfirmedBilling
Creating
Failed
Created
Succeeded
Canceled
Expired

PurchaseRequest

Object

Purchase request.

Name	Type	Default value	Description
properties.appliedScopeProperties	AppliedScopeProperties		Properties specific to applied scope type. Not required if not applicable.
properties.appliedScopeType	AppliedScopeType		Type of the Applied Scope.
properties.billingPlan	BillingPlan		Represents the billing plan in ISO 8601 format. Required only for monthly purchases.
properties.billingScopeId	string		Subscription that will be charged for purchasing SavingsPlan
properties.commitment	Commitment		Commitment towards the benefit.
properties.displayName	string		Friendly name of the savings plan
properties.renew	boolean	False	Setting this to true will automatically purchase a new benefit on the expiration date time.
properties.term	SavingsPlanTerm		Represents the Savings plan term in ISO 8601 format.
sku	Sku		The SKU to be applied for this resource

RenewProperties

Object

Properties specific to renew.

Name	Type	Description
purchaseProperties	PurchaseRequest	Purchase request.

SavingsPlanModel

Object

Savings plan

Name	Type	Default value	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.appliedScopeProperties	AppliedScopeProperties		Properties specific to applied scope type. Not required if not applicable.
properties.appliedScopeType	AppliedScopeType		Type of the Applied Scope.
properties.benefitStartTime	string (date-time)		This is the DateTime when the savings plan benefit starts.
properties.billingAccountId	string		Fully-qualified identifier of the billing account where the savings plan is applied.
properties.billingPlan	BillingPlan		Represents the billing plan in ISO 8601 format. Required only for monthly purchases.
properties.billingProfileId	string		Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers.
properties.billingScopeId	string		Subscription that will be charged for purchasing SavingsPlan
properties.commitment	Commitment		Commitment towards the benefit.
properties.customerId	string		Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers.
properties.displayName	string		Display name
properties.displayProvisioningState	string		The provisioning state of the savings plan for display, e.g. Succeeded
properties.effectiveDateTime	string (date-time)		DateTime of the savings plan starting when this version is effective from.
properties.expiryDateTime	string (date-time)		This is the date-time when the savings plan will expire.
properties.extendedStatusInfo	ExtendedStatusInfo		Extended status information
properties.productCode	string		Represents UPN
properties.provisioningState	ProvisioningState		Provisioning state
properties.purchaseDateTime	string (date-time)		Date time when the savings plan was purchased.
properties.renew	boolean	False	Setting this to true will automatically purchase a new benefit on the expiration date time.
properties.renewDestination	string		SavingsPlan Id of the SavingsPlan which is purchased because of renew.
properties.renewProperties	RenewProperties		Properties specific to renew.
properties.renewSource	string		SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed.
properties.term	SavingsPlanTerm		Represents the Savings plan term in ISO 8601 format.
properties.userFriendlyAppliedScopeType	string		The applied scope type of the savings plan for display, e.g. Shared
properties.utilization	Utilization		Savings plan utilization
sku	Sku		Savings plan SKU
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"

SavingsPlanModelListResult

Object

List of savings plans

Name	Type	Description
nextLink	string	Url to get the next page.
summary	SavingsPlanSummaryCount	The roll out count summary of the savings plans
value	SavingsPlanModel[]	Savings plan

SavingsPlanSummaryCount

Object

The roll up count summary of savings plans in each state

Name	Type	Description
cancelledCount	number	The number of savings plans in Cancelled state
expiredCount	number	The number of savings plans in Expired state
expiringCount	number	The number of savings plans in Expiring state
failedCount	number	The number of savings plans in Failed state
noBenefitCount	number	The number of savings plans in No Benefit state
pendingCount	number	The number of savings plans in Pending state
processingCount	number	The number of savings plans in Processing state
succeededCount	number	The number of savings plans in Succeeded state
warningCount	number	The number of savings plans in Warning state

SavingsPlanTerm

Enumeration

Represents the Savings plan term in ISO 8601 format.

Value	Description
P1Y
P3Y
P5Y

Sku

Object

The SKU to be applied for this resource

Name	Type	Description
name	string	Name of the SKU to be applied

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.

Utilization

Object

Savings plan utilization

Name	Type	Description
aggregates	UtilizationAggregates[]	The array of aggregates of a savings plan's utilization
trend	string	The trend for a savings plan's utilization

UtilizationAggregates

Object

The aggregate values of savings plan utilization

Name	Type	Description
grain	number	The grain of the aggregate
grainUnit	string	The grain unit of the aggregate
value	number	The aggregate value
valueUnit	string	The aggregate value unit