Microsoft.CostManagement (stable:2022-05-01)

2025/10/30 • 2 new, 2 deleted methods

GenerateCostDetailsReport_CreateOperation (new)
Description :  This API is the replacement for all previously release Usage Details APIs. Request to generate a cost details report for the provided date range, billing period (Only enterprise customers) or Invoice Id asynchronously at a certain scope. The initial call to request a report will return a 202 with a 'Location' and 'Retry-After' header. The 'Location' header will provide the endpoint to poll to get the result of the report generation. The 'Retry-After' provides the duration to wait before polling for the generated report. A call to poll the report operation will provide a 202 response with a 'Location' header if the operation is still in progress. Once the report generation operation completes, the polling endpoint will provide a 200 response along with details on the report blob(s) that are available for download. The details on the file(s) available for download will be available in the polling response body.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.CostManagement/generateCostDetailsReport
{
scope:
{
Description: The scope associated with usage details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create cost details operation. ,
Required: True ,
}
{
metric:
{
Description: The type of the detailed report. By default ActualCost is provided ,
Enum:
{
ActualCost: Actual cost data. ,
AmortizedCost: Amortized cost data. ,
}
,
Required: False ,
}
enum ,
timePeriod:
{
Description: The specific date range of cost details requested for the report. This parameter cannot be used alongside either the invoiceId or billingPeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. API only allows data to be pulled for 1 month or less and no older than 13 months. If no timePeriod or billingPeriod or invoiceId is provided the API defaults to the open month time period ,
Required: False ,
}
{
start:
{
Description: The start date to pull data from. example format 2020-03-15 ,
Required: True ,
}
string ,
end:
{
Description: The end date to pull data to. example format 2020-03-15 ,
Required: True ,
}
string ,
}
,
billingPeriod:
{
Description: This parameter can be used only by Enterprise Agreement customers. Use the YearMonth(e.g. 202008) format. This parameter cannot be used alongside either the invoiceId or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. ,
Required: False ,
}
string ,
invoiceId:
{
Description: This parameter can only be used by Microsoft Customer Agreement customers. Additionally, it can only be used at the Billing Profile or Customer scope. This parameter cannot be used alongside either the billingPeriod or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The id of the long running operation. ,
Required: False ,
}
string ,
name:
{
Description: The name of the long running operation. ,
Required: False ,
}
string ,
type:
{
Description: The type of the long running operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the cost details operation ,
Enum:
{
Completed: Operation is Completed. ,
NoDataFound: Operation is Completed and no cost data found. ,
Failed: Operation Failed. ,
}
,
Required: False ,
}
enum ,
manifest:
{
Description: The manifest of the report generated by the operation. ,
Required: False ,
}
{
manifestVersion:
{
Description: The Manifest version. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the report ,
Enum:
{
Csv: Csv data format. ,
}
,
Required: False ,
}
enum ,
byteCount:
{
Description: The total number of bytes in all blobs. ,
Format: int64 ,
Required: False ,
}
integer ,
blobCount:
{
Description: The total number of blobs. ,
Format: int32 ,
Required: False ,
}
integer ,
compressData:
{
Description: Is the data in compressed format. ,
Required: False ,
}
boolean ,
requestContext:
{
Description: The context of the Cost Details request. ,
Required: False ,
}
{
requestScope:
{
Description: The request scope of the request. ,
Required: False ,
}
string ,
requestBody:
{
Description: The request payload body provided in Cost Details call ,
Required: False ,
}
{
metric:
{
Description: The type of the detailed report. By default ActualCost is provided ,
Enum:
{
ActualCost: Actual cost data. ,
AmortizedCost: Amortized cost data. ,
}
,
Required: False ,
}
enum ,
timePeriod:
{
Description: The specific date range of cost details requested for the report. This parameter cannot be used alongside either the invoiceId or billingPeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. API only allows data to be pulled for 1 month or less and no older than 13 months. If no timePeriod or billingPeriod or invoiceId is provided the API defaults to the open month time period ,
Required: False ,
}
{
start:
{
Description: The start date to pull data from. example format 2020-03-15 ,
Required: True ,
}
string ,
end:
{
Description: The end date to pull data to. example format 2020-03-15 ,
Required: True ,
}
string ,
}
,
billingPeriod:
{
Description: This parameter can be used only by Enterprise Agreement customers. Use the YearMonth(e.g. 202008) format. This parameter cannot be used alongside either the invoiceId or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. ,
Required: False ,
}
string ,
invoiceId:
{
Description: This parameter can only be used by Microsoft Customer Agreement customers. Additionally, it can only be used at the Billing Profile or Customer scope. This parameter cannot be used alongside either the billingPeriod or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. ,
Required: False ,
}
string ,
}
,
}
,
blobs:
{
Description: List of blob information generated by this operation. ,
Required: False ,
}
[
{
blobLink:
{
Description: Link to the blob to download file. ,
Required: False ,
}
string ,
byteCount:
{
Description: Bytes in the blob. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
validTill:
{
Description: The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to check the result of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
GenerateCostDetailsReport_GetOperationResults (new)
Description :  Get the result of the specified operation. This link is provided in the CostDetails creation request response Location header.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/costDetailsOperationResults/{operationId}
{
scope:
{
Description: The scope associated with usage details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
operationId:
{
Description: The target operation Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the long running operation. ,
Required: False ,
}
string ,
name:
{
Description: The name of the long running operation. ,
Required: False ,
}
string ,
type:
{
Description: The type of the long running operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the cost details operation ,
Enum:
{
Completed: Operation is Completed. ,
NoDataFound: Operation is Completed and no cost data found. ,
Failed: Operation Failed. ,
}
,
Required: False ,
}
enum ,
manifest:
{
Description: The manifest of the report generated by the operation. ,
Required: False ,
}
{
manifestVersion:
{
Description: The Manifest version. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the report ,
Enum:
{
Csv: Csv data format. ,
}
,
Required: False ,
}
enum ,
byteCount:
{
Description: The total number of bytes in all blobs. ,
Format: int64 ,
Required: False ,
}
integer ,
blobCount:
{
Description: The total number of blobs. ,
Format: int32 ,
Required: False ,
}
integer ,
compressData:
{
Description: Is the data in compressed format. ,
Required: False ,
}
boolean ,
requestContext:
{
Description: The context of the Cost Details request. ,
Required: False ,
}
{
requestScope:
{
Description: The request scope of the request. ,
Required: False ,
}
string ,
requestBody:
{
Description: The request payload body provided in Cost Details call ,
Required: False ,
}
{
metric:
{
Description: The type of the detailed report. By default ActualCost is provided ,
Enum:
{
ActualCost: Actual cost data. ,
AmortizedCost: Amortized cost data. ,
}
,
Required: False ,
}
enum ,
timePeriod:
{
Description: The specific date range of cost details requested for the report. This parameter cannot be used alongside either the invoiceId or billingPeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. API only allows data to be pulled for 1 month or less and no older than 13 months. If no timePeriod or billingPeriod or invoiceId is provided the API defaults to the open month time period ,
Required: False ,
}
{
start:
{
Description: The start date to pull data from. example format 2020-03-15 ,
Required: True ,
}
string ,
end:
{
Description: The end date to pull data to. example format 2020-03-15 ,
Required: True ,
}
string ,
}
,
billingPeriod:
{
Description: This parameter can be used only by Enterprise Agreement customers. Use the YearMonth(e.g. 202008) format. This parameter cannot be used alongside either the invoiceId or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. ,
Required: False ,
}
string ,
invoiceId:
{
Description: This parameter can only be used by Microsoft Customer Agreement customers. Additionally, it can only be used at the Billing Profile or Customer scope. This parameter cannot be used alongside either the billingPeriod or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. ,
Required: False ,
}
string ,
}
,
}
,
blobs:
{
Description: List of blob information generated by this operation. ,
Required: False ,
}
[
{
blobLink:
{
Description: Link to the blob to download file. ,
Required: False ,
}
string ,
byteCount:
{
Description: Bytes in the blob. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
validTill:
{
Description: The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
GenerateCostDetailsReport_CreateOperation (removed)
Description :  This API is the replacement for all previously release Usage Details APIs. Request to generate a cost details report for the provided date range, billing period (Only enterprise customers) or Invoice Id asynchronously at a certain scope. The initial call to request a report will return a 202 with a 'Location' and 'Retry-After' header. The 'Location' header will provide the endpoint to poll to get the result of the report generation. The 'Retry-After' provides the duration to wait before polling for the generated report. A call to poll the report operation will provide a 202 response with a 'Location' header if the operation is still in progress. Once the report generation operation completes, the polling endpoint will provide a 200 response along with details on the report blob(s) that are available for download. The details on the file(s) available for download will be available in the polling response body.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.CostManagement/generateCostDetailsReport
{
scope:
{
Description: The scope associated with usage details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create cost details operation. ,
Required: True ,
}
{
metric:
{
Description: The type of the detailed report. By default ActualCost is provided ,
Enum:
{
ActualCost: Actual cost data. ,
AmortizedCost: Amortized cost data. ,
}
,
Required: False ,
}
enum ,
timePeriod:
{
Description: The specific date range of cost details requested for the report. This parameter cannot be used alongside either the invoiceId or billingPeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. API only allows data to be pulled for 1 month or less and no older than 13 months. If no timePeriod or billingPeriod or invoiceId is provided the API defaults to the open month time period ,
Required: False ,
}
{
start:
{
Description: The start date to pull data from. example format 2020-03-15 ,
Required: True ,
}
string ,
end:
{
Description: The end date to pull data to. example format 2020-03-15 ,
Required: True ,
}
string ,
}
,
billingPeriod:
{
Description: This parameter can be used only by Enterprise Agreement customers. Use the YearMonth(e.g. 202008) format. This parameter cannot be used alongside either the invoiceId or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. ,
Required: False ,
}
string ,
invoiceId:
{
Description: This parameter can only be used by Microsoft Customer Agreement customers. Additionally, it can only be used at the Billing Profile or Customer scope. This parameter cannot be used alongside either the billingPeriod or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The id of the long running operation. ,
Required: False ,
}
string ,
name:
{
Description: The name of the long running operation. ,
Required: False ,
}
string ,
type:
{
Description: The type of the long running operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the cost details operation ,
Enum:
{
Completed: Operation is Completed. ,
NoDataFound: Operation is Completed and no cost data found. ,
Failed: Operation Failed. ,
}
,
Required: False ,
}
enum ,
manifest:
{
Description: The manifest of the report generated by the operation. ,
Required: False ,
}
{
manifestVersion:
{
Description: The Manifest version. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the report ,
Enum:
{
Csv: Csv data format. ,
}
,
Required: False ,
}
enum ,
byteCount:
{
Description: The total number of bytes in all blobs. ,
Format: int64 ,
Required: False ,
}
integer ,
blobCount:
{
Description: The total number of blobs. ,
Format: int32 ,
Required: False ,
}
integer ,
compressData:
{
Description: Is the data in compressed format. ,
Required: False ,
}
boolean ,
requestContext:
{
Description: The context of the Cost Details request. ,
Required: False ,
}
{
requestScope:
{
Description: The request scope of the request. ,
Required: False ,
}
string ,
requestBody:
{
Description: The request payload body provided in Cost Details call ,
Required: False ,
}
{
metric:
{
Description: The type of the detailed report. By default ActualCost is provided ,
Enum:
{
ActualCost: Actual cost data. ,
AmortizedCost: Amortized cost data. ,
}
,
Required: False ,
}
enum ,
timePeriod:
{
Description: The specific date range of cost details requested for the report. This parameter cannot be used alongside either the invoiceId or billingPeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. API only allows data to be pulled for 1 month or less and no older than 13 months. If no timePeriod or billingPeriod or invoiceId is provided the API defaults to the open month time period ,
Required: False ,
}
{
start:
{
Description: The start date to pull data from. example format 2020-03-15 ,
Required: True ,
}
string ,
end:
{
Description: The end date to pull data to. example format 2020-03-15 ,
Required: True ,
}
string ,
}
,
billingPeriod:
{
Description: This parameter can be used only by Enterprise Agreement customers. Use the YearMonth(e.g. 202008) format. This parameter cannot be used alongside either the invoiceId or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. ,
Required: False ,
}
string ,
invoiceId:
{
Description: This parameter can only be used by Microsoft Customer Agreement customers. Additionally, it can only be used at the Billing Profile or Customer scope. This parameter cannot be used alongside either the billingPeriod or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. ,
Required: False ,
}
string ,
}
,
}
,
blobs:
{
Description: List of blob information generated by this operation. ,
Required: False ,
}
[
{
blobLink:
{
Description: Link to the blob to download file. ,
Required: False ,
}
string ,
byteCount:
{
Description: Bytes in the blob. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
validTill:
{
Description: The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to check the result of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
GenerateCostDetailsReport_GetOperationResults (removed)
Description :  Get the result of the specified operation. This link is provided in the CostDetails creation request response Location header.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.CostManagement/costDetailsOperationResults/{operationId}
{
scope:
{
Description: The scope associated with usage details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. ,
Required: True ,
}
string ,
operationId:
{
Description: The target operation Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the long running operation. ,
Required: False ,
}
string ,
name:
{
Description: The name of the long running operation. ,
Required: False ,
}
string ,
type:
{
Description: The type of the long running operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the cost details operation ,
Enum:
{
Completed: Operation is Completed. ,
NoDataFound: Operation is Completed and no cost data found. ,
Failed: Operation Failed. ,
}
,
Required: False ,
}
enum ,
manifest:
{
Description: The manifest of the report generated by the operation. ,
Required: False ,
}
{
manifestVersion:
{
Description: The Manifest version. ,
Required: False ,
}
string ,
dataFormat:
{
Description: The data format of the report ,
Enum:
{
Csv: Csv data format. ,
}
,
Required: False ,
}
enum ,
byteCount:
{
Description: The total number of bytes in all blobs. ,
Format: int64 ,
Required: False ,
}
integer ,
blobCount:
{
Description: The total number of blobs. ,
Format: int32 ,
Required: False ,
}
integer ,
compressData:
{
Description: Is the data in compressed format. ,
Required: False ,
}
boolean ,
requestContext:
{
Description: The context of the Cost Details request. ,
Required: False ,
}
{
requestScope:
{
Description: The request scope of the request. ,
Required: False ,
}
string ,
requestBody:
{
Description: The request payload body provided in Cost Details call ,
Required: False ,
}
{
metric:
{
Description: The type of the detailed report. By default ActualCost is provided ,
Enum:
{
ActualCost: Actual cost data. ,
AmortizedCost: Amortized cost data. ,
}
,
Required: False ,
}
enum ,
timePeriod:
{
Description: The specific date range of cost details requested for the report. This parameter cannot be used alongside either the invoiceId or billingPeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. API only allows data to be pulled for 1 month or less and no older than 13 months. If no timePeriod or billingPeriod or invoiceId is provided the API defaults to the open month time period ,
Required: False ,
}
{
start:
{
Description: The start date to pull data from. example format 2020-03-15 ,
Required: True ,
}
string ,
end:
{
Description: The end date to pull data to. example format 2020-03-15 ,
Required: True ,
}
string ,
}
,
billingPeriod:
{
Description: This parameter can be used only by Enterprise Agreement customers. Use the YearMonth(e.g. 202008) format. This parameter cannot be used alongside either the invoiceId or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. ,
Required: False ,
}
string ,
invoiceId:
{
Description: This parameter can only be used by Microsoft Customer Agreement customers. Additionally, it can only be used at the Billing Profile or Customer scope. This parameter cannot be used alongside either the billingPeriod or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. ,
Required: False ,
}
string ,
}
,
}
,
blobs:
{
Description: List of blob information generated by this operation. ,
Required: False ,
}
[
{
blobLink:
{
Description: Link to the blob to download file. ,
Required: False ,
}
string ,
byteCount:
{
Description: Bytes in the blob. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
validTill:
{
Description: The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}