Entitlements
Get Metric Access
GET

/api/metric_access/

X-API-KEY*
X-API-KEY*
curl --request GET \
  --url https://api.uselotus.io/api/metric_access/ \
  --header 'X-API-KEY: <x-api-key>'
lotus.check_metric_access(
  customer_id="cust_0569173ee6654369",
  metric_id="metric_a47ac0bf",
)

Authorizations

X-API-KEY[header]required
string

Query Parameters

customer_idrequired
string

The customer_id of the customer you want to check access.

metric_idrequired
string

The metric_id of the metric you want to check access for.

subscription_filters
array

Used if you want to restrict the access check to only plans that fulfill certain subscription filter criteria. If your billing model does not have the ability multiple plans or subscriptions per customer, this is likely not relevant for you.

Response

accessrequired
boolean

Whether or not the customer has access to this metric. The default behavior for this is whether all of the customer's plans (that have access to the metric) are below the total limit of the metric. If you have specified subscription filters, then this will be whether all of the customer's plans that match the subscription filters are below the total limit of the metric. You can customize the behavior of this flag by setting a policy in your Organization settings in the frontend.

access_per_subscriptionrequired
array
customerrequired
object
metricrequired
object