Usage

Get subscription usage

Changed on

Retrieve aggregated usage data for a subscription's usage-based components. If start_date/end_date are omitted, defaults to the current billing period.

get/api/v1/usage/subscription/{subscription_id}

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Path parameters

subscription_idstring MeteroidId required
Example:sub_7n42DGM5Tflk9n8mt7Fhc7

Subscription ID

Query parameters

start_datestring date
end_datestring date
metric_idstring MeteroidId
Example:bm_7n42DGM5Tflk9n8mt7Fhc7

Response

Subscription usage data

period_endstring date required
period_startstring date required

Example response

{
  "usage": [
    {
      "metric_id": "bm_7n42DGM5Tflk9n8mt7Fhc7"
    }
  ]
}

Changes

  • v1de35c02bb0d2Revision changes
    • breaking

      for the query request parameter metric_id, the format changed from no format to MeteroidId

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • info

      added the non-success response with the status

  • v116817b48a08dRevision changes
    • info

      endpoint added