Lotus home pagelight logo
Entitlements
Get Feature Access
GET

/api/feature_access/

X-API-KEY*
X-API-KEY*
curl --request GET \
  --url https://api.uselotus.io/api/feature_access/ \
  --header 'X-API-KEY: <x-api-key>'
lotus.check_feature_access(
  customer_id="cust_0569173ee6654369",
  feature_id="feature_a47ac0bf",
)

​
Authorizations

X-API-KEY[header]required
string

​
Query Parameters

customer_idrequired
string

The customer_id of the customer you want to check access.

feature_idrequired
string

The feature_id of the feature you want to check access for.

subscription_filters
array

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.

​
Response

accessrequired
boolean

Whether or not the customer has access to this feature. The default behavior for this is whether any of the customer's plans have access to this feature. If you have specified subscription filters, then this will be whether any of the customer's plans that match the subscription filters have access to this feature. 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
featurerequired
object