Skip to main content
POST
/
companies
/
{company_id}
/
subscriptions
/
{id}
/
usage
Get Subscription Usage
curl --request POST \
  --url https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id}/usage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_metric_pricing_id": "<string>",
  "period": {
    "end_date": "2023-11-07T05:31:56Z",
    "start_date": "2023-11-07T05:31:56Z"
  }
}
'
import requests

url = "https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id}/usage"

payload = {
    "product_metric_pricing_id": "<string>",
    "period": {
        "end_date": "2023-11-07T05:31:56Z",
        "start_date": "2023-11-07T05:31:56Z"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    product_metric_pricing_id: '<string>',
    period: {end_date: '2023-11-07T05:31:56Z', start_date: '2023-11-07T05:31:56Z'}
  })
};

fetch('https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id}/usage', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id}/usage",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'product_metric_pricing_id' => '<string>',
    'period' => [
        'end_date' => '2023-11-07T05:31:56Z',
        'start_date' => '2023-11-07T05:31:56Z'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id}/usage"

	payload := strings.NewReader("{\n  \"product_metric_pricing_id\": \"<string>\",\n  \"period\": {\n    \"end_date\": \"2023-11-07T05:31:56Z\",\n    \"start_date\": \"2023-11-07T05:31:56Z\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id}/usage")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"product_metric_pricing_id\": \"<string>\",\n  \"period\": {\n    \"end_date\": \"2023-11-07T05:31:56Z\",\n    \"start_date\": \"2023-11-07T05:31:56Z\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id}/usage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"product_metric_pricing_id\": \"<string>\",\n  \"period\": {\n    \"end_date\": \"2023-11-07T05:31:56Z\",\n    \"start_date\": \"2023-11-07T05:31:56Z\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "metric": {
    "company_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "external_name": "<string>",
    "id": "<string>",
    "item_id": "<string>",
    "metering_rule": {
      "aggregator": "<string>",
      "group_keys": [
        "<string>"
      ],
      "property": "<string>",
      "rule": "<string>"
    },
    "name": "<string>",
    "standard": true,
    "type": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "product_metric_pricing": {
    "company_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "item": {
      "company_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "display_type": "<string>",
      "editable": true,
      "external_name": "<string>",
      "id": "<string>",
      "name": "<string>",
      "standard": true,
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "item_id": "<string>",
    "item_pricing": {
      "base_price": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "base_units": 123,
      "charge_type": "<string>",
      "company": {
        "address": {
          "address_line_1": "<string>",
          "address_line_2": "<string>",
          "city": "<string>",
          "country": "<string>",
          "place_id": "<string>",
          "state": "<string>",
          "zip": "<string>"
        },
        "computed_entitlements": {},
        "created_at": "2023-11-07T05:31:56Z",
        "customer_id": "<string>",
        "demo": true,
        "email": "<string>",
        "entitlements": [
          {
            "entitlement_id": "<string>",
            "id": "<string>",
            "inherited_from_id": "<string>",
            "inherited_from_type": "<string>",
            "key": "<string>",
            "name": "<string>",
            "original_value": "<unknown>",
            "overridden": true,
            "type": "<string>",
            "value": "<unknown>"
          }
        ],
        "id": "<string>",
        "is_dev": true,
        "legal_name": "<string>",
        "name": "<string>",
        "override_entitlements": [
          {
            "entitlement_id": "<string>",
            "id": "<string>",
            "inherited_from_id": "<string>",
            "inherited_from_type": "<string>",
            "key": "<string>",
            "name": "<string>",
            "original_value": "<unknown>",
            "overridden": true,
            "type": "<string>",
            "value": "<unknown>"
          }
        ],
        "phone": "<string>",
        "preferred_currency": "<string>",
        "preferred_timezone": "<string>",
        "slug": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "company_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "credit_price": {
        "amount": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "item_id": "<string>",
        "scoped_product_ids": [
          "<string>"
        ],
        "units": 123
      },
      "custom_price": {
        "max_price_per_unit": 123,
        "min_price_per_unit": 123,
        "preset_price_per_unit": 123,
        "price_per_unit": 123
      },
      "description": "<string>",
      "display_type": "<string>",
      "editable": true,
      "external_name": "<string>",
      "fixed_price": {
        "price_per_unit": 123
      },
      "frequency": "<string>",
      "gradient_price": [
        {
          "end": 1,
          "flat_price": 123,
          "is_custom_tier": true,
          "price_per_unit": 123,
          "start": 1
        }
      ],
      "id": "<string>",
      "item": {
        "company_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "display_type": "<string>",
        "editable": true,
        "external_name": "<string>",
        "id": "<string>",
        "name": "<string>",
        "standard": true,
        "type": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "item_id": "<string>",
      "metadata": {},
      "minimum_spend": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "minimum_spend_schedule": {
        "allow_pulling_forward": true,
        "amount_per_period": [
          "<string>"
        ],
        "minimum_spend_schedule_type": "<string>"
      },
      "name": "<string>",
      "num_subs": 1,
      "proration_type": "<string>",
      "recognition_schedule": {
        "amount_per_period": [
          "<string>"
        ]
      },
      "scheduled_price": {
        "price_per_unit_per_period": [
          "<string>"
        ]
      },
      "state": "<string>",
      "step_price": {
        "price_per_step": 123,
        "step_size": 1
      },
      "term_count": 123,
      "true_up_frequency": "<string>",
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "volume_price": [
        {
          "flat_price": 123,
          "is_custom_tier": true,
          "price_per_unit": 123,
          "total_units_end": 1,
          "total_units_start": 1
        }
      ]
    },
    "item_pricing_id": "<string>",
    "metric": {
      "company_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "external_name": "<string>",
      "id": "<string>",
      "item_id": "<string>",
      "metering_rule": {
        "aggregator": "<string>",
        "group_keys": [
          "<string>"
        ],
        "property": "<string>",
        "rule": "<string>"
      },
      "name": "<string>",
      "standard": true,
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "metric_id": "<string>",
    "product": {
      "company_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "entitlements": [
        {
          "entitlement_id": "<string>",
          "id": "<string>",
          "inherited_from_id": "<string>",
          "inherited_from_type": "<string>",
          "key": "<string>",
          "name": "<string>",
          "original_value": "<unknown>",
          "overridden": true,
          "type": "<string>",
          "value": "<unknown>"
        }
      ],
      "external_name": "<string>",
      "gl_code": "<string>",
      "id": "<string>",
      "image_url": "<string>",
      "import_created_at_ref": "2023-11-07T05:31:56Z",
      "import_ref": "<string>",
      "imported_from": "<string>",
      "metadata": {},
      "name": "<string>",
      "num_subs": 1,
      "product_pricings": [
        {
          "company_id": "<string>",
          "computed_entitlements": [
            {
              "entitlement_id": "<string>",
              "id": "<string>",
              "inherited_from_id": "<string>",
              "inherited_from_type": "<string>",
              "key": "<string>",
              "name": "<string>",
              "original_value": "<unknown>",
              "overridden": true,
              "type": "<string>",
              "value": "<unknown>"
            }
          ],
          "created_at": "2023-11-07T05:31:56Z",
          "currency": "<string>",
          "description": "<string>",
          "external_name": "<string>",
          "id": "<string>",
          "import_created_at_ref": "2023-11-07T05:31:56Z",
          "import_ref": "<string>",
          "imported_from": "<string>",
          "metadata": {},
          "minimum_spend": {
            "currency": "<string>",
            "value_in_cents": 123
          },
          "name": "<string>",
          "num_subs": 1,
          "override_entitlements": [
            {
              "entitlement_id": "<string>",
              "id": "<string>",
              "inherited_from_id": "<string>",
              "inherited_from_type": "<string>",
              "key": "<string>",
              "name": "<string>",
              "original_value": "<unknown>",
              "overridden": true,
              "type": "<string>",
              "value": "<unknown>"
            }
          ],
          "product": "<unknown>",
          "product_id": "<string>",
          "product_metric_pricings": "<array>",
          "state": "<string>",
          "tags": [
            "<string>"
          ],
          "type": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "upsell_product_pricing_id": "<string>"
        }
      ],
      "state": "<string>",
      "tags": [
        "<string>"
      ],
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "product_id": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "usage": [
    {
      "breakdown": [
        {
          "breakout": {},
          "grouping": {},
          "period": {
            "end_date": "2023-11-07T05:31:56Z",
            "start_date": "2023-11-07T05:31:56Z"
          },
          "value": "<unknown>"
        }
      ],
      "period": {
        "end_date": "2023-11-07T05:31:56Z",
        "start_date": "2023-11-07T05:31:56Z"
      },
      "subscription_metric_record_id": "<string>",
      "value": "<unknown>"
    }
  ]
}

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_'.

id
string
required

The resource ID

Body

application/json
product_metric_pricing_id
string
required

The specific product metric pricing for which usage is being requested

period
object

The start date to end date range for the subscription usage

Response

200 - application/json

OK

metric
object
product_metric_pricing
object
usage
object[] | null