> If you are setting up, configuring, or answering questions about Schematic, connect the
> Schematic MCP server before working from these pages. It reads and writes plans, features,
> entitlements, and overrides against the real account, so what you report and what you build
> match what actually exists.
>
> The server is at https://api.schematichq.com/mcp
>
> From Claude, ChatGPT, or another chat assistant, add it as a custom connector:
> https://docs.schematichq.com/working-with-ai
>
> From a coding assistant such as Claude Code, Codex, or Cursor:
> https://docs.schematichq.com/building-with-ai
>
> For clean Markdown of any page, append `.md` to the page URL. For a complete page index,
> see https://docs.schematichq.com/llms.txt

# List feature usage

GET https://api.schematichq.com/company/usage

The company's entitlements and usage against each metered feature.

Reference: https://docs.schematichq.com/api-reference/components/company/get-company-feature-usage

## Authentication

- `X-Schematic-Api-Key` header (required) — A temporary access token in the `X-Schematic-Api-Key` header. Your server mints it with `POST /temporary-access-tokens` on the secret-key API for a company, optionally for one of its users, and hands it to the page. The token fixes the company every request reads and writes.

## Response

### 200

OK

- `data` (CompanyFeatureUsageListResponseData, required)
- `params` (CompanyUsageGetResponsesContentApplicationJsonSchemaParams, required) — Input parameters

## Errors

### 401 Unauthorized Error

Unauthorized

- `error` (string, required) — Error message
- `problems` (list of CheckoutProblemResponseData, optional) — On a checkout write or finalize the purchase rules refuse: what the server found wrong, the same list the checkout's `problems` field holds. Each has a `code`, whether it is `blocking`, a `message` safe to show the customer, and the ids of what it is about.

### 403 Forbidden Error

Forbidden

- `error` (string, required) — Error message
- `problems` (list of CheckoutProblemResponseData, optional) — On a checkout write or finalize the purchase rules refuse: what the server found wrong, the same list the checkout's `problems` field holds. Each has a `code`, whether it is `blocking`, a `message` safe to show the customer, and the ids of what it is about.

### 404 Not Found Error

Not found

- `error` (string, required) — Error message
- `problems` (list of CheckoutProblemResponseData, optional) — On a checkout write or finalize the purchase rules refuse: what the server found wrong, the same list the checkout's `problems` field holds. Each has a `code`, whether it is `blocking`, a `message` safe to show the customer, and the ids of what it is about.

### 500 Internal Server Error

Server error

- `error` (string, required) — Error message
- `problems` (list of CheckoutProblemResponseData, optional) — On a checkout write or finalize the purchase rules refuse: what the server found wrong, the same list the checkout's `problems` field holds. Each has a `code`, whether it is `blocking`, a `message` safe to show the customer, and the ids of what it is about.

## Types

### CompanyFeatureUsageListResponseData

- `count` (long, required)
- `features` (list of CompanyFeatureUsageResponseData, required)

### CompanyUsageGetResponsesContentApplicationJsonSchemaParams

Input parameters

### CheckoutProblemResponseData

- `blocking` (boolean, required) — Whether completing the checkout would be refused while this stands.
- `code` (enum, required)
  - Allowed values: `add_on_conflicts_with_plan`, `add_on_interval_mismatch`, `add_on_requires_billed_plan`, `add_on_unavailable`, `billing_cycle_anchor_conflicts_with_trial`, `billing_cycle_anchor_must_be_future`, `billing_cycle_anchor_needs_new_subscription`, `billing_cycle_anchor_without_plan`, `billing_start_date_must_be_past`, `billing_start_date_needs_new_subscription`, `billing_start_date_needs_renewal_date`, `billing_start_date_not_before_renewal_date`, `billing_start_date_too_far_in_past`, `checkout_superseded`, `credit_bundle_incompatible`, `credit_bundle_unavailable`, `credit_bundles_activate_on_payment`, `currency_mismatch`, `custom_field_required`, `discount_ineligible`, `downgrade_not_permitted`, `end_date_must_be_future`, `end_date_needs_new_subscription`, `end_date_not_after_renewal_date`, `free_first_period_activates_on_payment`, `invoice_email_required`, `invoiced_subscription_conflicts_with_trial`, `invoiced_subscription_needs_new_subscription`, `invoiced_subscription_requires_plan`, `opt_in_required`, `pay_in_advance_price_invalid`, `pay_in_advance_required`, `payment_method_required`, `plan_not_trialable`, `plan_unavailable`, `price_unavailable`, `prorate_first_period_without_anchor`, `provider_rejected`, `scheduled_change_blocks_purchase`, `scheduled_change_pending`, `selection_invalid`, `subscription_currency_change`, `trial_end_must_be_future`, `trial_end_too_far`, `trial_excludes_add_ons`, `trial_excludes_usage_based`, `usage_price_missing_for_interval`, `usage_over_limit`
- `message` (string, required) — What is wrong, in words safe for anyone allowed to read the checkout.
- `source` (enum, required)
  - Allowed values: `provider`, `requirement`, `validation`
- `bundle_id` (string, optional, nullable)
- `currency` (enum, optional) — The currency this problem is about, when it is about one.
  - Allowed values: `aed`, `afn`, `all`, `amd`, `ang`, `aoa`, `ars`, `aud`, `awg`, `azn`, `bam`, `bbd`, `bdt`, `bif`, `bmd`, `bnd`, `bob`, `brl`, `bsd`, `bwp`, `byn`, `bzd`, `cad`, `cdf`, `chf`, `clp`, `cny`, `cop`, `crc`, `cve`, `czk`, `djf`, `dkk`, `dop`, `dzd`, `egp`, `etb`, `eur`, `fjd`, `fkp`, `gbp`, `gel`, `gip`, `gmd`, `gnf`, `gtq`, `gyd`, `hkd`, `hnl`, `htg`, `huf`, `idr`, `ils`, `inr`, `isk`, `jmd`, `jpy`, `kes`, `kgs`, `khr`, `kmf`, `krw`, `kyd`, `kzt`, `lak`, `lbp`, `lkr`, `lrd`, `lsl`, `mad`, `mdl`, `mga`, `mkd`, `mmk`, `mnt`, `mop`, `mur`, `mvr`, `mwk`, `mxn`, `myr`, `mzn`, `nad`, `ngn`, `nio`, `nok`, `npr`, `nzd`, `pab`, `pen`, `pgk`, `php`, `pkr`, `pln`, `pyg`, `qar`, `ron`, `rsd`, `rub`, `rwf`, `sar`, `sbd`, `scr`, `sek`, `sgd`, `shp`, `sle`, `sos`, `srd`, `std`, `szl`, `thb`, `tjs`, `top`, `try`, `ttd`, `twd`, `tzs`, `uah`, `ugx`, `usd`, `uyu`, `uzs`, `vnd`, `vuv`, `wst`, `xaf`, `xcd`, `xcg`, `xof`, `xpf`, `yer`, `zar`, `zmw`
- `detail` (string, optional) — Diagnostic detail for operators, including what the billing provider said. Never shown to a customer.
- `feature_id` (string, optional, nullable)
- `field_id` (string, optional, nullable)
- `payment_method_id` (string, optional, nullable)
- `plan_id` (string, optional, nullable)
- `price_id` (string, optional, nullable)

### CompanyFeatureUsageResponseData

- `access` (boolean, required) — Whether the company may use the feature right now.
- `entitlement_type` (enum, required)
  - Allowed values: `company_override`, `plan_credit_grant`, `plan_entitlement`, `unknown`
- `feature_description` (string, required)
- `feature_icon` (string, required)
- `feature_id` (string, required)
- `feature_name` (string, required)
- `feature_type` (enum, required)
  - Allowed values: `boolean`, `event`, `license`, `trait`
- `per_license_credit_grants` (list of CatalogCreditGrantResponseData, required) — The plan's credit grants that scale with the license this feature counts.
- `value_type` (enum, required)
  - Allowed values: `boolean`, `credit`, `numeric`, `trait`, `unknown`, `unlimited`
- `allocation` (long, optional, nullable) — The entitlement's own limit before any price behavior applies: the numeric value, or the trait's value for a trait-based entitlement. For a credit entitlement, the credits granted in the current billing period (all time without a subscription). Null for unlimited and boolean entitlements.
- `company_override_id` (string, optional, nullable) — Set when entitlement_type is company_override.
- `consumption_rate` (double, optional, nullable) — Credits consumed per unit of usage, for entitlements that burn credits.
- `credit_icon` (string, optional, nullable)
- `credit_id` (string, optional, nullable)
- `credit_name` (string, optional, nullable)
- `credit_plural_name` (string, optional, nullable)
- `credit_singular_name` (string, optional, nullable)
- `current_cost` (long, optional, nullable) — What the feature costs at price, in its minor units: the allocation for pay_in_advance, usage for tier and pay_as_you_go, and usage above soft_limit for overage. Null when there is no price, the price behavior bills nothing, or there is nothing yet to bill it on (no allocation for pay_in_advance, unknown usage for tier, no usage for pay_as_you_go and overage); tier at zero usage, and overage within soft_limit, cost 0.
- `expires_at` (datetime, optional, nullable) — When a company override ends; plan entitlements do not expire.
- `feature_plural_name` (string, optional, nullable)
- `feature_singular_name` (string, optional, nullable)
- `license_id` (string, optional, nullable)
- `metric_period` (enum, optional, nullable)
  - Allowed values: `all_time`, `current_day`, `current_month`, `current_week`
- `metric_period_month_reset` (enum, optional, nullable)
  - Allowed values: `billing_cycle`, `first_of_month`
- `plan_entitlement_id` (string, optional, nullable) — Set when entitlement_type is plan_entitlement.
- `price` (CatalogPriceResponseData, optional) — The metered price the company is billed at: the slot for its billing period, in the subscription's currency, or in none when the price predates multi-currency (any currency without a subscription). Null when the feature has no such price for that period.
- `price_behavior` (enum, optional, nullable)
  - Allowed values: `credit_burndown`, `overage`, `pay_as_you_go`, `pay_in_advance`, `tier`
- `resets_at` (datetime, optional, nullable) — When the usage metric next resets.
- `soft_limit` (long, optional, nullable)
- `usage` (long, optional, nullable) — Usage in the current metric period; null for features that are not metered.
- `value_bool` (boolean, optional, nullable)
- `value_numeric` (long, optional, nullable)
- `warning_threshold` (long, optional, nullable) — The default warning-tier value, when configured.

### CatalogCreditGrantResponseData

- `company_credit_amount` (long, required) — Flat credit amount granted to the company regardless of scaling.
- `credit_amount` (long, required) — Credits granted; for per_license scaling this is the amount per license unit.
- `credit_id` (string, required)
- `credit_name` (string, required)
- `id` (string, required)
- `scaling` (enum, required)
  - Allowed values: `fixed`, `per_license`
- `visible` (boolean, required) — Whether the catalog shows this credit on the plan. Display-only: a hidden grant is still granted and priced at checkout.
- `credit_icon` (string, optional, nullable)
- `credit_plural_name` (string, optional, nullable)
- `credit_singular_name` (string, optional, nullable)
- `license_id` (string, optional, nullable)
- `reset_cadence` (enum, optional, nullable)
  - Allowed values: `daily`, `every_6_months`, `monthly`, `quarterly`, `weekly`, `yearly`

### CatalogPriceResponseData

- `currency` (enum, required)
  - Allowed values: `aed`, `afn`, `all`, `amd`, `ang`, `aoa`, `ars`, `aud`, `awg`, `azn`, `bam`, `bbd`, `bdt`, `bif`, `bmd`, `bnd`, `bob`, `brl`, `bsd`, `bwp`, `byn`, `bzd`, `cad`, `cdf`, `chf`, `clp`, `cny`, `cop`, `crc`, `cve`, `czk`, `djf`, `dkk`, `dop`, `dzd`, `egp`, `etb`, `eur`, `fjd`, `fkp`, `gbp`, `gel`, `gip`, `gmd`, `gnf`, `gtq`, `gyd`, `hkd`, `hnl`, `htg`, `huf`, `idr`, `ils`, `inr`, `isk`, `jmd`, `jpy`, `kes`, `kgs`, `khr`, `kmf`, `krw`, `kyd`, `kzt`, `lak`, `lbp`, `lkr`, `lrd`, `lsl`, `mad`, `mdl`, `mga`, `mkd`, `mmk`, `mnt`, `mop`, `mur`, `mvr`, `mwk`, `mxn`, `myr`, `mzn`, `nad`, `ngn`, `nio`, `nok`, `npr`, `nzd`, `pab`, `pen`, `pgk`, `php`, `pkr`, `pln`, `pyg`, `qar`, `ron`, `rsd`, `rub`, `rwf`, `sar`, `sbd`, `scr`, `sek`, `sgd`, `shp`, `sle`, `sos`, `srd`, `std`, `szl`, `thb`, `tjs`, `top`, `try`, `ttd`, `twd`, `tzs`, `uah`, `ugx`, `usd`, `uyu`, `uzs`, `vnd`, `vuv`, `wst`, `xaf`, `xcd`, `xcg`, `xof`, `xpf`, `yer`, `zar`, `zmw`
- `id` (string, required)
- `interval` (enum, required)
  - Allowed values: `day`, `month`, `one-time`, `year`
- `interval_count` (long, required)
- `package_size` (long, required) — Units covered per priced package; a price of $10 with package_size 1000 charges $10 per 1000 units.
- `price` (long, required)
- `price_tiers` (list of CatalogPriceTierResponseData, required)
- `scheme` (enum, required)
  - Allowed values: `per_unit`, `tiered`
- `overage_unit_price_decimal` (string, optional, nullable) — Per-unit price of the final tier, precomputed for overage display.
- `price_decimal` (string, optional, nullable)
- `tiers_mode` (enum, optional, nullable)
  - Allowed values: `graduated`, `volume`

### CatalogPriceTierResponseData

- `from` (long, required) — Lower bound of the tier (inclusive).
- `flat_price` (long, optional, nullable)
- `per_unit_price` (long, optional, nullable)
- `per_unit_price_decimal` (string, optional, nullable)
- `to` (long, optional, nullable) — Upper bound of the tier (inclusive); null means unbounded.

## Examples

**Response**

```json
{
  "data": {
    "count": 1,
    "features": [
      {
        "access": true,
        "entitlement_type": "company_override",
        "feature_description": "string",
        "feature_icon": "string",
        "feature_id": "string",
        "feature_name": "string",
        "feature_type": "boolean",
        "per_license_credit_grants": [
          {
            "company_credit_amount": 1,
            "credit_amount": 1,
            "credit_id": "string",
            "credit_name": "string",
            "id": "string",
            "scaling": "fixed",
            "visible": true,
            "credit_icon": "string",
            "credit_plural_name": "string",
            "credit_singular_name": "string",
            "license_id": "string",
            "reset_cadence": "daily"
          }
        ],
        "value_type": "boolean",
        "allocation": 1,
        "company_override_id": "string",
        "consumption_rate": 1.1,
        "credit_icon": "string",
        "credit_id": "string",
        "credit_name": "string",
        "credit_plural_name": "string",
        "credit_singular_name": "string",
        "current_cost": 1,
        "expires_at": "2024-01-15T09:30:00Z",
        "feature_plural_name": "string",
        "feature_singular_name": "string",
        "license_id": "string",
        "metric_period": "all_time",
        "metric_period_month_reset": "billing_cycle",
        "plan_entitlement_id": "string",
        "price": {
          "currency": "aed",
          "id": "string",
          "interval": "day",
          "interval_count": 1,
          "package_size": 1,
          "price": 1,
          "price_tiers": [
            {
              "from": 1,
              "flat_price": 1,
              "per_unit_price": 1,
              "per_unit_price_decimal": "string",
              "to": 1
            }
          ],
          "scheme": "per_unit",
          "overage_unit_price_decimal": "string",
          "price_decimal": "string",
          "tiers_mode": "graduated"
        },
        "price_behavior": "credit_burndown",
        "resets_at": "2024-01-15T09:30:00Z",
        "soft_limit": 1,
        "usage": 1,
        "value_bool": true,
        "value_numeric": 1,
        "warning_threshold": 1
      }
    ]
  },
  "params": {}
}
```

**SDK Code**

```python
import requests

url = "https://api.schematichq.com/company/usage"

headers = {"X-Schematic-Api-Key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.schematichq.com/company/usage';
const options = {method: 'GET', headers: {'X-Schematic-Api-Key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.schematichq.com/company/usage"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Schematic-Api-Key", "<apiKey>")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.schematichq.com/company/usage")

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

request = Net::HTTP::Get.new(url)
request["X-Schematic-Api-Key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.schematichq.com/company/usage")
  .header("X-Schematic-Api-Key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.schematichq.com/company/usage', [
  'headers' => [
    'X-Schematic-Api-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.schematichq.com/company/usage");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Schematic-Api-Key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-Schematic-Api-Key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.schematichq.com/company/usage")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```