Sign in

v1

latestOpenAPI 3.0.32026-07-1336286494.8 KB
api

get/api/customer_metric_access/

Query parameters

customer_idstring nullable required

The customer_id of the customer you want to check access.

event_namestring nullable

The name of the event you are checking access for.

metric_idstring uuid nullable

The metric_id of the metric you are checking access for. Please note that you must porovide exactly one of event_name and metric_id are mutually; a validation error will be thrown if both or none are provided.

valuestring required
property_namestring required

The string name of the property to filter on. Example: 'product_id'

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. This must be passed in as a stringified JSON object.

Response

plan_idstring required

The plan_id of the plan we are checking that has access to this feature.