GET
/
api
/
customer_feature_access
/
curl --request GET \
  --url https://api.uselotus.io/api/customer_feature_access/ \
  --header 'X-API-KEY: <api-key>'
[
  {
    "access": true,
    "feature_name": "<string>",
    "plan_id": "<string>",
    "subscription_filters": [
      {
        "property_name": "<string>",
        "value": "<string>"
      }
    ]
  }
]
lotus.get_customer_feature_access(
  customer_id= "cust_0569173ee6654369",
  feature_name="premium_support",
)

Authorizations

X-API-KEY
string
headerrequired

Query Parameters

customer_id
string | null
required

The customer_id of the customer you want to check access.

feature_name
string
required

Name of the feature to check access for.

subscription_filters
object[]

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

200 - application/json
access
boolean
required

Whether or not the plan has access to this feature. If your customer can have multiple plans or subscriptions, then you must check the 'access' across all returned plans to determine if the customer can access this feature.

feature_name
string
required

Name of the feature to check access for.

plan_id
string
required

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

subscription_filters
object[]
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.