Skip to main content
POST
/
companies
/
{company_id}
/
billable_metrics
/
find
Find Billable Metrics
curl --request POST \
  --url https://api.getmeasure.com/api/v1/companies/{company_id}/billable_metrics/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pagination": {
    "from_key": "<string>",
    "limit": 20
  },
  "sort_key": "createdAtDesc",
  "include_meta": true,
  "query": {
    "external_name": "<string>",
    "item_id": "<string>",
    "name": "<string>",
    "state": "<string>"
  }
}
'
{
  "pagination": {
    "from_key": "<string>",
    "limit": 123
  },
  "results": [
    {
      "company_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "editable": true,
      "external_name": "<string>",
      "id": "<string>",
      "is_billable": true,
      "item_id": "<string>",
      "metering_rule": {
        "aggregator": "<string>",
        "group_keys": [
          "<string>"
        ],
        "property": "<string>",
        "rule": {
          "comparator": {
            "items": "<array>",
            "left_item": {
              "comparator": "<unknown>",
              "item_type": "<string>",
              "property": "<string>",
              "value": "<string>"
            },
            "right_item": {
              "comparator": "<unknown>",
              "item_type": "<string>",
              "property": "<string>",
              "value": "<string>"
            },
            "type": "<string>"
          }
        }
      },
      "name": "<string>",
      "standard": true,
      "state": "<string>",
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.getmeasure.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

​
company_id
string
required

The company ID with the prefix 'cmp_'.

Body

application/json
​
pagination
object
required

The pagination parameters for the request

​
sort_key
enum<string>
default:createdAtDesc
required
Available options:
createdAtDesc,
createdAtAsc,
updatedAtAsc,
updatedAtDesc
​
include_meta
boolean | null

Whether to include additional metadata in the pagination response such the number of total results

​
query
object

The query criteria for the request

Response

200 - application/json

OK

​
pagination
object
​
results
object[] | null