Sign in

v1

latestOpenAPI 3.0.32026-07-1336286494.8 KB
api

get/api/customer_feature_access/

Query parameters

customer_idstring nullable required

The customer_id of the customer you want to check access.

feature_namestring required

Name of the feature to check access for.

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

feature_namestring required

Name of the feature to check access for.

plan_idstring required

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

accessboolean 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.