Skip to main content

Get Usage Summary​

This API can be used by MSP to get an overview of all service usage and cost summary from all customer accounts. For SaaS Storage and any volume commit services, customer can see the pooled usage and cost; for utility services and Account commit services, customer can see the aggregated usage and cost.

Query Parameters
  • usageMonth string

    Optional - Month for which usage summary is returned If not provided, default to current month

Responses

OK

Schema
  • data object[]

    List of usage summary

  • usageMonth string

    Month for which pooled usage is returned

  • skuId string

    Service sku ID

  • consumedQuantity integer

    Peak usage quantity up to usageDate in usage month This quantity uses the measurement of our billing unit

  • entitledQuantity integer

    Pre-committed quantity in usage month For commit skus, it's the purchased quantity sent in fulfillment

  • overageQuantity integer

    Quantity used more than entitled quantity in usage month For commit skus, it's consumedQuantity minus entitledQuantity (0 if consumedQuantity is smaller than entitledQuantity)

  • billableQuantity integer

    Quantity that will be charged in usage month consumedQuantity minus entitledQuantity (0 if consumedQuantity is smaller than entitledQuantity)

  • unitPrice integer

    Price for a single billingUnit

  • billingUnit string

    Service unit

  • totalCost integer

    billableQuantity * unitPrice

  • currency string

    Billing currency

  • paymentOption string

    For commit skus, it's "upfront"

GET /api/v1/partner/usage/summary

Authorization

Request

Click Edit to configure Base URL
https://api.metallic.io
Bearer Token
usageMonth — query
curl -L -X GET 'https://api.metallic.io/api/v1/partner/usage/summary' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'