The vCloud Air Platform APIs include the following GET operations that you can use to retrieve metering and billing information for your Virtual Private Cloud OnDemand account.

Resource Usage API Operations for Virtual Private Cloud OnDemand

Request

Response

Parameters

Description

GET /api/metering/service-group/{service-group-id}/billable-costs

BilledCosts

month=..

year=....

Returns the billable value of cost items associated with a service group:

Support Cost

Service Credit

GET /api/metering/service-instance/{service-instance-id}/billable-usage

BilledUsage

month=..

year=....

level=....

Returns all billable usage for an instance. The response includes rolled-up usage for all L2 entities associated with the instance. Usage can be rolled up over a period of hours, days, or months, or for a specified time.

GET /api/metering/service-instance/{service-instance-id}/l1/{l1-id}/billable-usage

BilledUsage

month=..

year=....

Returns all billable usage for an L1 entity. This request returns aggregated usage data. Usage can be aggregated over a period of hours, days, or months, or for a specified time.

GET /api/metering/service-instance/{service-instance-id}/l2/{l2-id}/billable-usage

BilledUsage

month=..

year=....

Returns all billable usage for an L2 entity. This request returns rolled-up usage for all L1 entities associated with the L2 entity. Usage can be rolled up over a period of hours, days, or months, or for a specified time.

GET /api/billing/service-groups

ServiceGroups

Returns all service groups for a company:

Company details

Service group

Billing currency

Spend threshold and other billing attributes

Anniversary dates

The OAuth token determines the company for which service group details are returned.

GET /api/billing/service-group/{service-group-id}

ServiceGroup

Returns service group details:

Billing currency

Spend threshold and other billing attributes

Anniversary dates

GET /api/billing/service-group/{service-group-id}/billed-costs

BillableCosts

Returns the costs associated with a service group for a billing cycle:

Support Cost

Service Credit

GET /api/billing/service-group/{service-group-id}/billed-usage

BillableUsage

start=

end= or

duration=...

Returns all billed usage for a service group post invoicing. This request returns all rolled-up usage for all L1 entities and L2 entities associated with the service group ID.

GET /api/billing/service-instance/{service-instance-id}/l1/{l1-id}/billed-usage

BillableUsage

start=

end= or

duration=...

Returns all billed usage for an L1 entity post invoicing. Usage can be aggregated over a billing month or for a specified time.

GET /api/billing/service-instance/{service-instance-id}/l2/{l2-id}/billed-usage

BillableUsage

start=

end= or

duration=...

Returns all billed usage for an L2 entity post invoicing. This request returns rolled-up usage for all L1 entities associated with the L2 entity. Usage can be rolled up over a billing month or for a specified time.