---
title: "GET /api/customer_metric_access/"
method: GET
path: "/api/customer_metric_access/"
tags: ["api"]
deprecated: true
---

# GET /api/customer_metric_access/

`GET /api/customer_metric_access/`

> **Deprecated.**

## Query parameters

- `customer_id` string, nullable, required
- `event_name` string, nullable
- `metric_id` string, uuid, nullable
- `subscription_filters` SubscriptionFilterRequest[]
  - `value` string, required
  - `property_name` string, required — The string name of the property to filter on. Example: 'product_id'

## Response `200`

- GetEventAccess[]
  - `plan_id` string, required — The plan_id of the plan we are checking that has access to this feature.
  - `subscription_filters` SubscriptionFilter[], required — The subscription filters that are applied to this plan's relationship with the customer. If your billing model does not have the ability multiple plans or subscriptions per customer, this is likely not relevant for you.
    - `value` string, required
    - `property_name` string, required — The string name of the property to filter on. Example: 'product_id'
  - `usage_per_component` ComponentUsage[], required — The usage of each component of the plan the customer is on. Only components that match the request will be included: If metric_id is provided, this will be a list of length 1. If event_name is provided, this will be a list of length 1 or more depending on how many components of the customer's plan use this event.
    - `event_name` string, required — The name of the event you are checking access for.
    - `metric_name` string, required — The name of the metric.
    - `metric_id` string, required — The metric_id of the metric. This metric_id can be found in the Lotus frontend if you haven't seen it before.
    - `metric_usage` number, double, required — The current usage of the metric. Keep in mind the current usage of the metric can be different from the billable usage of the metric.
    - `metric_free_limit` number, double, nullable, required — If you specified a free tier of usage for this metric, this is the amount of usage that is free. Will be null if you did not specify a free tier for this metric.
    - `metric_total_limit` number, double, nullable, required — The total limit of the metric. Will be null if you did not specify a limit for this metric.

---

[API](https://skmtc.net/uselotus/apis/lotus-api.md) · [All operations](https://skmtc.net/uselotus/apis/lotus-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/uselotus/lotus-api/versions/1f59f4fea13f/schema)