GET
/
api
/
metric_access
/
curl --request GET \
  --url https://api.uselotus.io/api/metric_access/ \
  --header 'X-API-KEY: <api-key>'
{
  "customer": {
    "customer_name": "<string>",
    "email": "jsmith@example.com",
    "customer_id": "<string>"
  },
  "access": true,
  "metric": {
    "metric_id": "<string>",
    "event_name": "<string>",
    "metric_name": "<string>"
  },
  "access_per_subscription": [
    {
      "subscription": {
        "start_date": "2023-11-07T05:31:56Z",
        "end_date": "2023-11-07T05:31:56Z",
        "subscription_filters": [
          {
            "value": "<string>",
            "property_name": "<string>"
          }
        ],
        "plan": {
          "plan_name": "<string>",
          "plan_id": "<string>",
          "version_id": "<string>",
          "version": 123
        }
      },
      "metric_usage": 5000000000,
      "metric_free_limit": 5000000000,
      "metric_total_limit": 5000000000
    }
  ]
}
lotus.check_metric_access(
  customer_id="cust_0569173ee6654369",
  metric_id="metric_a47ac0bf",
)

Authorizations

X-API-KEY
string
headerrequired

Query Parameters

customer_id
string | null
required

The customer_id of the customer you want to check access.

metric_id
string
required

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

subscription_filters
object[]

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

200 - application/json
customer
object
required
access
boolean
required

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.

metric
object
required
access_per_subscription
object[]
required