List plan entitlements

1 import { SchematicClient } from "@schematichq/schematic-typescript-node"; 2 3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" }); 4 await client.entitlements.listPlanEntitlements();

1 { 2 "data": [ 3 { 4 "created_at": "2024-01-15T09:30:00Z", 5 "environment_id": "environment_id", 6 "feature_id": "feature_id", 7 "id": "id", 8 "plan_id": "plan_id", 9 "rule_id": "rule_id", 10 "updated_at": "2024-01-15T09:30:00Z", 11 "value_type": "value_type", 12 "feature": { 13 "created_at": "2024-01-15T09:30:00Z", 14 "description": "description", 15 "feature_type": "feature_type", 16 "icon": "icon", 17 "id": "id", 18 "name": "name", 19 "updated_at": "2024-01-15T09:30:00Z" 20 }, 21 "metered_monthly_price": { 22 "billing_scheme": "billing_scheme", 23 "created_at": "2024-01-15T09:30:00Z", 24 "currency": "currency", 25 "id": "id", 26 "interval": "interval", 27 "is_active": true, 28 "package_size": 1, 29 "price": 1, 30 "price_external_id": "price_external_id", 31 "price_id": "price_id", 32 "price_tier": [ 33 {} 34 ], 35 "product_external_id": "product_external_id", 36 "product_id": "product_id", 37 "product_name": "product_name", 38 "updated_at": "2024-01-15T09:30:00Z", 39 "usage_type": "usage_type" 40 }, 41 "metered_yearly_price": { 42 "billing_scheme": "billing_scheme", 43 "created_at": "2024-01-15T09:30:00Z", 44 "currency": "currency", 45 "id": "id", 46 "interval": "interval", 47 "is_active": true, 48 "package_size": 1, 49 "price": 1, 50 "price_external_id": "price_external_id", 51 "price_id": "price_id", 52 "price_tier": [ 53 {} 54 ], 55 "product_external_id": "product_external_id", 56 "product_id": "product_id", 57 "product_name": "product_name", 58 "updated_at": "2024-01-15T09:30:00Z", 59 "usage_type": "usage_type" 60 }, 61 "metric_period": "metric_period", 62 "metric_period_month_reset": "metric_period_month_reset", 63 "plan": { 64 "created_at": "2024-01-15T09:30:00Z", 65 "description": "description", 66 "icon": "icon", 67 "id": "id", 68 "name": "name", 69 "plan_type": "plan_type", 70 "updated_at": "2024-01-15T09:30:00Z" 71 }, 72 "price_behavior": "price_behavior", 73 "rule_id_usage_exceeded": "rule_id_usage_exceeded", 74 "soft_limit": 1, 75 "usage_based_product": { 76 "account_id": "account_id", 77 "created_at": "2024-01-15T09:30:00Z", 78 "currency": "currency", 79 "environment_id": "environment_id", 80 "external_id": "external_id", 81 "is_active": true, 82 "name": "name", 83 "price": 1.1, 84 "product_id": "product_id", 85 "quantity": 1.1, 86 "updated_at": "2024-01-15T09:30:00Z" 87 }, 88 "value_bool": true, 89 "value_numeric": 1, 90 "value_trait": { 91 "created_at": "2024-01-15T09:30:00Z", 92 "display_name": "display_name", 93 "entity_type": "entity_type", 94 "hierarchy": [ 95 "hierarchy" 96 ], 97 "id": "id", 98 "trait_type": "trait_type", 99 "updated_at": "2024-01-15T09:30:00Z" 100 }, 101 "value_trait_id": "value_trait_id" 102 } 103 ], 104 "params": { 105 "feature_id": "feature_id", 106 "feature_ids": [ 107 "feature_ids" 108 ], 109 "ids": [ 110 "ids" 111 ], 112 "limit": 1, 113 "offset": 1, 114 "plan_id": "plan_id", 115 "plan_ids": [ 116 "plan_ids" 117 ], 118 "q": "q", 119 "with_metered_products": true 120 } 121 }

Query parameters

feature_idstringOptional

Filter plan entitlements by a single feature ID (starting with feat_)

feature_idsstringOptional

Filter plan entitlements by multiple feature IDs (starting with feat_)

idsstringOptional

Filter plan entitlements by multiple plan entitlement IDs (starting with pltl_)

plan_idstringOptional

Filter plan entitlements by a single plan ID (starting with plan_)

plan_idsstringOptional

Filter plan entitlements by multiple plan IDs (starting with plan_)

qstringOptional

Search for plan entitlements by feature or company name

with_metered_productsbooleanOptional

Filter plan entitlements only with metered products

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

The returned resources

paramsobject

Input parameters

List plan entitlements

Headers

Query parameters

Response

Errors