Savings Plan Order - Get

Service:

Billing Benefits

API Version:

2022-11-01

Get a savings plan order.

GET https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}?api-version=2022-11-01

With optional parameters:

GET https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}?api-version=2022-11-01&$expand={$expand}

URI Parameters

Name	In	Required	Type	Description
savingsPlanOrderId	path	True	string	Order ID of the savings plan
api-version	query	True	string	The api-version to be used by the service
$expand	query		string	May be used to expand the detail information of some properties.

Responses

Name	Type	Description
200 OK	SavingsPlanOrderModel	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

SavingsPlanOrderGet

SavingsPlanOrderWithExpandedPaymentsGet

SavingsPlanOrderGet

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000?api-version=2022-11-01

Java

/**
 * Samples for SavingsPlanOrder Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/
     * SavingsPlanOrderGet.json
     */
    /**
     * Sample code: SavingsPlanOrderGet.
     * 
     * @param manager Entry point to BillingBenefitsManager.
     */
    public static void savingsPlanOrderGet(com.azure.resourcemanager.billingbenefits.BillingBenefitsManager manager) {
        manager.savingsPlanOrders().getWithResponse("20000000-0000-0000-0000-000000000000", null,
            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.billingbenefits import BillingBenefitsRP

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billingbenefits
# USAGE
    python savings_plan_order_get.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 = BillingBenefitsRP(
        credential=DefaultAzureCredential(),
    )

    response = client.savings_plan_order.get(
        savings_plan_order_id="20000000-0000-0000-0000-000000000000",
    )
    print(response)


# x-ms-original-file: specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanOrderGet.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 armbillingbenefits_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/billingbenefits/armbillingbenefits/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanOrderGet.json
func ExampleSavingsPlanOrderClient_Get_savingsPlanOrderGet() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbillingbenefits.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSavingsPlanOrderClient().Get(ctx, "20000000-0000-0000-0000-000000000000", &armbillingbenefits.SavingsPlanOrderClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %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.SavingsPlanOrderModel = armbillingbenefits.SavingsPlanOrderModel{
	// 	Name: to.Ptr("20000000-0000-0000-0000-000000000000"),
	// 	Type: to.Ptr("Microsoft.BillingBenefits/savingsPlanOrders"),
	// 	ID: to.Ptr("/providers/microsoft.billingbenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000"),
	// 	Properties: &armbillingbenefits.SavingsPlanOrderModelProperties{
	// 		BillingAccountID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000000:20000000-0000-3000-0000-000000000000_2019-05-31"),
	// 		BillingPlan: to.Ptr(armbillingbenefits.BillingPlanP1M),
	// 		BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000000:20000000-0000-3000-0000-000000000000_2019-05-31/billingProfiles/KPSV-DWNE-BG7-TGB"),
	// 		BillingScopeID: to.Ptr("20000000-0000-0000-0000-000000000005"),
	// 		DisplayName: to.Ptr("Compute_SavingsPlan_10-19-2022_11-01"),
	// 		ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-10-19T18:03:55.251Z"); return t}()),
	// 		ProvisioningState: to.Ptr(armbillingbenefits.ProvisioningStateSucceeded),
	// 		SavingsPlans: []*string{
	// 			to.Ptr("/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000")},
	// 			Term: to.Ptr(armbillingbenefits.TermP3Y),
	// 		},
	// 		SKU: &armbillingbenefits.SKU{
	// 			Name: to.Ptr("Compute_Savings_Plan"),
	// 		},
	// 	}
}

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 { BillingBenefitsRP } = require("@azure/arm-billingbenefits");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get a savings plan order.
 *
 * @summary Get a savings plan order.
 * x-ms-original-file: specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanOrderGet.json
 */
async function savingsPlanOrderGet() {
  const savingsPlanOrderId = "20000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new BillingBenefitsRP(credential);
  const result = await client.savingsPlanOrder.get(savingsPlanOrderId);
  console.log(result);
}

savingsPlanOrderGet().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

{
  "id": "/providers/microsoft.billingbenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000",
  "name": "20000000-0000-0000-0000-000000000000",
  "type": "Microsoft.BillingBenefits/savingsPlanOrders",
  "properties": {
    "billingScopeId": "20000000-0000-0000-0000-000000000005",
    "savingsPlans": [
      "/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000"
    ],
    "billingPlan": "P1M",
    "term": "P3Y",
    "displayName": "Compute_SavingsPlan_10-19-2022_11-01",
    "provisioningState": "Succeeded",
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000000:20000000-0000-3000-0000-000000000000_2019-05-31/billingProfiles/KPSV-DWNE-BG7-TGB",
    "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000000:20000000-0000-3000-0000-000000000000_2019-05-31",
    "expiryDateTime": "2025-10-19T18:03:55.2519794Z"
  },
  "sku": {
    "name": "Compute_Savings_Plan"
  }
}

SavingsPlanOrderWithExpandedPaymentsGet

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000?api-version=2022-11-01&$expand=schedule

Java

/**
 * Samples for SavingsPlanOrder Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/
     * SavingsPlanOrderExpandedGet.json
     */
    /**
     * Sample code: SavingsPlanOrderWithExpandedPaymentsGet.
     * 
     * @param manager Entry point to BillingBenefitsManager.
     */
    public static void savingsPlanOrderWithExpandedPaymentsGet(
        com.azure.resourcemanager.billingbenefits.BillingBenefitsManager manager) {
        manager.savingsPlanOrders().getWithResponse("20000000-0000-0000-0000-000000000000", "schedule",
            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.billingbenefits import BillingBenefitsRP

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billingbenefits
# USAGE
    python savings_plan_order_expanded_get.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 = BillingBenefitsRP(
        credential=DefaultAzureCredential(),
    )

    response = client.savings_plan_order.get(
        savings_plan_order_id="20000000-0000-0000-0000-000000000000",
    )
    print(response)


# x-ms-original-file: specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanOrderExpandedGet.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 armbillingbenefits_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/billingbenefits/armbillingbenefits/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanOrderExpandedGet.json
func ExampleSavingsPlanOrderClient_Get_savingsPlanOrderWithExpandedPaymentsGet() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbillingbenefits.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSavingsPlanOrderClient().Get(ctx, "20000000-0000-0000-0000-000000000000", &armbillingbenefits.SavingsPlanOrderClientGetOptions{Expand: to.Ptr("schedule")})
	if err != nil {
		log.Fatalf("failed to finish the request: %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.SavingsPlanOrderModel = armbillingbenefits.SavingsPlanOrderModel{
	// 	Name: to.Ptr("20000000-0000-0000-0000-000000000000"),
	// 	Type: to.Ptr("Microsoft.BillingBenefits/savingsPlanOrders"),
	// 	ID: to.Ptr("/providers/microsoft.billingbenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000"),
	// 	Properties: &armbillingbenefits.SavingsPlanOrderModelProperties{
	// 		BillingAccountID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000000:20000000-0000-3000-0000-000000000000_2019-05-31"),
	// 		BillingPlan: to.Ptr(armbillingbenefits.BillingPlanP1M),
	// 		BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000000:20000000-0000-3000-0000-000000000000_2019-05-31/billingProfiles/KPSV-DWNE-BG7-TGB"),
	// 		BillingScopeID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/1234567/billingSubscriptions/30000000-0000-0000-0000-000000000003"),
	// 		DisplayName: to.Ptr("Compute_SavingsPlan_10-19-2022_11-01"),
	// 		ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-10-19T18:03:55.251Z"); return t}()),
	// 		PlanInformation: &armbillingbenefits.BillingPlanInformation{
	// 			NextPaymentDueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2022-11-19"); return t}()),
	// 			PricingCurrencyTotal: &armbillingbenefits.Price{
	// 				Amount: to.Ptr[float64](26.28),
	// 				CurrencyCode: to.Ptr("USD"),
	// 			},
	// 			StartDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2022-10-19"); return t}()),
	// 			Transactions: []*armbillingbenefits.PaymentDetail{
	// 				{
	// 					BillingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2022-10-19"); return t}()),
	// 					PaymentDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2022-10-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatus("Completed")),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2022-11-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2022-12-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-01-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-02-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-03-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-04-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-05-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-06-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-07-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-08-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-09-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-10-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-11-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-12-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2024-01-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2024-02-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2024-03-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2024-04-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2024-05-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2024-06-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2024-07-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2024-08-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2024-09-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2024-10-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2024-11-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2024-12-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2025-01-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2025-02-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2025-03-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2025-04-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2025-05-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2025-06-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2025-07-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2025-08-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 				},
	// 				{
	// 					DueDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2025-09-19"); return t}()),
	// 					PricingCurrencyTotal: &armbillingbenefits.Price{
	// 						Amount: to.Ptr[float64](0.73),
	// 						CurrencyCode: to.Ptr("USD"),
	// 					},
	// 					Status: to.Ptr(armbillingbenefits.PaymentStatusScheduled),
	// 			}},
	// 		},
	// 		ProvisioningState: to.Ptr(armbillingbenefits.ProvisioningStateSucceeded),
	// 		SavingsPlans: []*string{
	// 			to.Ptr("/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000")},
	// 			Term: to.Ptr(armbillingbenefits.TermP3Y),
	// 		},
	// 		SKU: &armbillingbenefits.SKU{
	// 			Name: to.Ptr("Compute_Savings_Plan"),
	// 		},
	// 	}
}

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 { BillingBenefitsRP } = require("@azure/arm-billingbenefits");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get a savings plan order.
 *
 * @summary Get a savings plan order.
 * x-ms-original-file: specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanOrderExpandedGet.json
 */
async function savingsPlanOrderWithExpandedPaymentsGet() {
  const savingsPlanOrderId = "20000000-0000-0000-0000-000000000000";
  const expand = "schedule";
  const options = { expand };
  const credential = new DefaultAzureCredential();
  const client = new BillingBenefitsRP(credential);
  const result = await client.savingsPlanOrder.get(savingsPlanOrderId, options);
  console.log(result);
}

savingsPlanOrderWithExpandedPaymentsGet().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

{
  "id": "/providers/microsoft.billingbenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000",
  "name": "20000000-0000-0000-0000-000000000000",
  "type": "Microsoft.BillingBenefits/savingsPlanOrders",
  "properties": {
    "billingScopeId": "/providers/Microsoft.Billing/billingAccounts/1234567/billingSubscriptions/30000000-0000-0000-0000-000000000003",
    "savingsPlans": [
      "/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000"
    ],
    "billingPlan": "P1M",
    "term": "P3Y",
    "displayName": "Compute_SavingsPlan_10-19-2022_11-01",
    "provisioningState": "Succeeded",
    "planInformation": {
      "pricingCurrencyTotal": {
        "currencyCode": "USD",
        "amount": 26.28
      },
      "startDate": "2022-10-19",
      "nextPaymentDueDate": "2022-11-19",
      "transactions": [
        {
          "dueDate": "2022-10-19",
          "paymentDate": "2022-10-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "billingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Completed"
        },
        {
          "dueDate": "2022-11-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2022-12-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2023-01-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2023-02-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2023-03-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2023-04-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2023-05-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2023-06-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2023-07-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2023-08-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2023-09-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2023-10-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2023-11-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2023-12-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2024-01-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2024-02-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2024-03-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2024-04-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2024-05-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2024-06-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2024-07-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2024-08-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2024-09-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2024-10-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2024-11-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2024-12-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2025-01-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2025-02-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2025-03-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2025-04-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2025-05-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2025-06-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2025-07-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2025-08-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        },
        {
          "dueDate": "2025-09-19",
          "pricingCurrencyTotal": {
            "currencyCode": "USD",
            "amount": 0.73
          },
          "status": "Scheduled"
        }
      ]
    },
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000000:20000000-0000-3000-0000-000000000000_2019-05-31/billingProfiles/KPSV-DWNE-BG7-TGB",
    "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000000:20000000-0000-3000-0000-000000000000_2019-05-31",
    "expiryDateTime": "2025-10-19T18:03:55.2519794Z"
  },
  "sku": {
    "name": "Compute_Savings_Plan"
  }
}

Definitions

Name	Description
BillingPlan	Represents the billing plan in ISO 8601 format. Required only for monthly billing plans.
BillingPlanInformation	Information describing the type of billing plan for this savings plan.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExtendedStatusInfo
PaymentDetail	Information about payment related to a savings plan order.
PaymentStatus	Describes whether the payment is completed, failed, cancelled or scheduled in the future.
Price
ProvisioningState	Provisioning state
SavingsPlanOrderModel	Savings plan order
Sku	The SKU to be applied for this resource
systemData	Metadata pertaining to creation and last modification of the resource.
Term	Represent benefit term in ISO 8601 format.

BillingPlan

Enumeration

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

Value	Description
P1M

BillingPlanInformation

Object

Information describing the type of billing plan for this savings plan.

Name	Type	Description
nextPaymentDueDate	string (date)	For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off.
pricingCurrencyTotal	Price	Amount of money to be paid for the Order. Tax is not included.
startDate	string (date)	Date when the billing plan has started.
transactions	PaymentDetail[]	Information about payment related to a savings plan order.

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

Name	Type	Description
message	string	The message giving detailed information about the status code.
statusCode	string	Status code providing additional information.

PaymentDetail

Object

Information about payment related to a savings plan order.

Name	Type	Description
billingAccount	string	Billing account
billingCurrencyTotal	Price	Amount charged in Billing currency. Tax not included. Is null for future payments
dueDate	string (date)	Date when the payment needs to be done.
extendedStatusInfo	ExtendedStatusInfo
paymentDate	string (date)	Date when the transaction is completed. Is null when it is scheduled.
pricingCurrencyTotal	Price	Amount in pricing currency. Tax not included.
status	PaymentStatus	Describes whether the payment is completed, failed, cancelled or scheduled in the future.

PaymentStatus

Enumeration

Describes whether the payment is completed, failed, cancelled or scheduled in the future.

Value	Description
Succeeded
Failed
Scheduled
Cancelled

Price

Object

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

ProvisioningState

Enumeration

Provisioning state

Value	Description
Creating
PendingBilling
ConfirmedBilling
Created
Succeeded
Cancelled
Expired
Failed

SavingsPlanOrderModel

Object

Savings plan order

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.benefitStartTime	string (date-time)	This is the DateTime when the savings plan benefit started.
properties.billingAccountId	string	Fully-qualified identifier of the billing account where the savings plan is applied. Present only for Enterprise Agreement customers.
properties.billingPlan	BillingPlan	Represents the billing plan in ISO 8601 format. Required only for monthly billing plans.
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 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.expiryDateTime	string (date-time)	Expiry date time
properties.extendedStatusInfo	ExtendedStatusInfo
properties.planInformation	BillingPlanInformation	Information describing the type of billing plan for this savings plan.
properties.provisioningState	ProvisioningState	Provisioning state
properties.savingsPlans	string[]	Identifier of the savings plan
properties.term	Term	Represent benefit term in ISO 8601 format.
sku	Sku	Savings plan SKU
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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.

Term

Enumeration

Represent benefit term in ISO 8601 format.

Value	Description
P1Y
P3Y
P5Y