List Billable Metrics

API Reference

V1

Customers

Get billable metrics for a customer

get/v1/customers/{customer_id}/billable-metrics

Get all billable metrics for a given customer.

Path Parameters

customer_idstring

formatuuid

Query Parameters

include_archivedboolean

optional

If true, the list of returned metrics will include archived metrics

limitnumber

optional

Max number of results that should be returned

minimum1

maximum100

next_pagestring

optional

Cursor that indicates where the next page of results should start.

on_current_planboolean

optional

If true, the list of metrics will be filtered to just ones that are on the customer's current plan

Returns

dataarray of object

next_pagestring

HTTPTypeScriptPythonGoRubyTerraform

curl https://api.metronome.com/v1/customers/$CUSTOMER_ID/billable-metrics \
    -H "Authorization: Bearer $METRONOME_BEARER_TOKEN"

200 Example

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "name": "name",
      "aggregate": "aggregate",
      "aggregate_keys": [
        "string"
      ],
      "aggregation_key": "aggregation_key",
      "aggregation_type": "COUNT",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "custom_fields": {
        "foo": "string"
      },
      "event_type_filter": {
        "in_values": [
          "string"
        ],
        "not_in_values": [
          "string"
        ]
      },
      "filter": {
        "foo": "bar"
      },
      "group_by": [
        "string"
      ],
      "group_keys": [
        [
          "string"
        ]
      ],
      "property_filters": [
        {
          "name": "name",
          "exists": true,
          "in_values": [
            "string"
          ],
          "not_in_values": [
            "string"
          ]
        }
      ],
      "sql": "sql"
    }
  ],
  "next_page": "next_page"
}