---
title: "GET /api/feature_access/"
method: GET
path: "/api/feature_access/"
tags: ["api"]
---

# GET /api/feature_access/

`GET /api/feature_access/`

## Query parameters

- `customer_id` string, nullable, required
- `feature_id` string, uuid, required
- `subscription_filters` SubscriptionFilterRequest[]
  - `value` string, required
  - `property_name` string, required — The string name of the property to filter on. Example: 'product_id'

## Response `200`

- FeatureAccessResponse
  - `customer` LightweightCustomer, required
    - `customer_name` string, nullable, required — The display name of the customer
    - `email` string, email, nullable, required — The primary email address of the customer, must be the same as the email address used to create the customer in the payment provider
    - `customer_id` string, nullable, required — The id provided when creating the customer, we suggest matching with your internal customer id in your backend
  - `access` boolean, required — 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.
  - `feature` Feature, required
    - `feature_id` string, required
    - `feature_name` string, required
    - `feature_description` string, nullable, required
  - `access_per_subscription` FeatureAccessPerSubscription[], required
    - `subscription` AccessMethodsSubscriptionRecord, required
      - `start_date` string, date-time, required — The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.
      - `end_date` string, date-time, required — The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.
      - `subscription_filters` SubscriptionFilter[], required
        - `value` string, required
        - `property_name` string, required — The string name of the property to filter on. Example: 'product_id'
      - `plan` LightweightPlanVersion, required
        - `plan_name` string, required
        - `plan_id` string, required
        - `version_id` string, required
        - `version` union, required
          - integer
          - 'custom_version'
    - `access` boolean, required

---

[API](https://skmtc.net/uselotus/apis/lotus-api.md) · [All operations](https://skmtc.net/uselotus/apis/lotus-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/uselotus/lotus-api/versions/1f59f4fea13f/schema)