Edit

Migrate from the EA Billing Periods API

  • Article

EA customers that previously used the Billing periods Enterprise Reporting consumption.azure.com API to get their billing periods need to use different mechanisms to get the data they need. This article helps you migrate from the old API by using replacement APIs.

Note

On May 1, 2024, Azure Enterprise Reporting APIs will be retired. Migrate to Microsoft Cost Management APIs before then.

Endpoints to migrate off:

Endpoint API Comments
/v2/enrollments/{enrollmentNumber}/billingperiods • API method: GET
• Synchronous (non polling)
• Data format: JSON

New solutions

There's no new single API that has the same functionality that returns billing periods with consumption data and that returns the API routes for the four sets of data. Instead, you call each new API individually. If data of the requested type is available, it gets included in the response. Otherwise, no data is included in the response.

The Balance Summary and Price Sheet APIs use the billing period as a parameter. Create your GET request with the billing period using the year and month (yyyyMM) format.

Balance Summary

Call the new Balances API to get either the balances for all billing periods or the balances for a specific billing period.

Usage Details

To get usage details, use either Cost Management Exports or the Cost Management Cost Details API. You can get the cost and usage details data for a time period. If data exists for the specified period, it gets returned. Otherwise, no data is included in the response.

The billing period can be represented in the Usage Details alternatives by using the billing period time frame as the selected start and end date.

For more information about each option, see Migrate from EA Usage Details APIs.

Marketplace charges

Call the List Marketplaces API to get a list of available marketplaces in reverse chronological order by billing period.

Price Sheet

Call the new Price Sheet API to get the price sheet for either the current billing period or for a specific billing period.

Next steps