Update plan entitlement

1 import { SchematicClient } from "@schematichq/schematic-typescript-node"; 2 3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" }); 4 await client.entitlements.updatePlanEntitlement("plan_entitlement_id", { 5 valueType: "boolean" 6 });

1 { 2 "data": { 3 "created_at": "foo", 4 "environment_id": "foo", 5 "feature_id": "foo", 6 "id": "foo", 7 "plan_id": "foo", 8 "rule_id": "foo", 9 "updated_at": "foo", 10 "value_type": "foo", 11 "consumption_rate": 42, 12 "feature": { 13 "created_at": "foo", 14 "description": "foo", 15 "feature_type": "foo", 16 "icon": "foo", 17 "id": "foo", 18 "name": "foo", 19 "updated_at": "foo", 20 "event_subtype": "foo", 21 "lifecycle_phase": "foo", 22 "maintainer_id": "foo", 23 "plural_name": "foo", 24 "singular_name": "foo", 25 "trait_id": "foo" 26 }, 27 "metered_monthly_price": { 28 "billing_scheme": "foo", 29 "created_at": "foo", 30 "currency": "foo", 31 "id": "foo", 32 "interval": "foo", 33 "is_active": true, 34 "package_size": 42, 35 "price": 42, 36 "price_external_id": "foo", 37 "price_id": "foo", 38 "price_tier": [ 39 { 40 "flat_amount": 42, 41 "per_unit_price": 42, 42 "per_unit_price_decimal": "foo", 43 "up_to": 42 44 } 45 ], 46 "product_external_id": "foo", 47 "product_id": "foo", 48 "product_name": "foo", 49 "updated_at": "foo", 50 "usage_type": "foo", 51 "meter_event_name": "foo", 52 "meter_event_payload_key": "foo", 53 "meter_id": "foo", 54 "price_decimal": "foo", 55 "tiers_mode": "foo" 56 }, 57 "metered_yearly_price": { 58 "billing_scheme": "foo", 59 "created_at": "foo", 60 "currency": "foo", 61 "id": "foo", 62 "interval": "foo", 63 "is_active": true, 64 "package_size": 42, 65 "price": 42, 66 "price_external_id": "foo", 67 "price_id": "foo", 68 "price_tier": [ 69 { 70 "flat_amount": 42, 71 "per_unit_price": 42, 72 "per_unit_price_decimal": "foo", 73 "up_to": 42 74 } 75 ], 76 "product_external_id": "foo", 77 "product_id": "foo", 78 "product_name": "foo", 79 "updated_at": "foo", 80 "usage_type": "foo", 81 "meter_event_name": "foo", 82 "meter_event_payload_key": "foo", 83 "meter_id": "foo", 84 "price_decimal": "foo", 85 "tiers_mode": "foo" 86 }, 87 "metric_period": "foo", 88 "metric_period_month_reset": "foo", 89 "plan": { 90 "created_at": "foo", 91 "description": "foo", 92 "icon": "foo", 93 "id": "foo", 94 "name": "foo", 95 "plan_type": "foo", 96 "updated_at": "foo", 97 "audience_type": "foo" 98 }, 99 "price_behavior": "foo", 100 "rule_id_usage_exceeded": "foo", 101 "soft_limit": 42, 102 "usage_based_product": { 103 "account_id": "foo", 104 "created_at": "foo", 105 "currency": "foo", 106 "environment_id": "foo", 107 "external_id": "foo", 108 "is_active": true, 109 "name": "foo", 110 "price": 42, 111 "product_id": "foo", 112 "quantity": 42, 113 "updated_at": "foo", 114 "price_decimal": "foo" 115 }, 116 "value_bool": true, 117 "value_credit": { 118 "burn_strategy": "foo", 119 "created_at": "foo", 120 "default_expiry_unit": "foo", 121 "default_rollover_policy": "foo", 122 "description": "foo", 123 "id": "foo", 124 "name": "foo", 125 "updated_at": "foo", 126 "default_expiry_unit_count": 42, 127 "icon": "foo", 128 "monthly_price": { 129 "currency": "foo", 130 "external_price_id": "foo", 131 "id": "foo", 132 "interval": "foo", 133 "price": 42, 134 "scheme": "foo", 135 "price_decimal": "foo" 136 }, 137 "plural_name": "foo", 138 "product": { 139 "account_id": "foo", 140 "created_at": "foo", 141 "currency": "foo", 142 "environment_id": "foo", 143 "external_id": "foo", 144 "is_active": true, 145 "name": "foo", 146 "price": 42, 147 "product_id": "foo", 148 "quantity": 42, 149 "updated_at": "foo", 150 "price_decimal": "foo" 151 }, 152 "singular_name": "foo", 153 "yearly_price": { 154 "currency": "foo", 155 "external_price_id": "foo", 156 "id": "foo", 157 "interval": "foo", 158 "price": 42, 159 "scheme": "foo", 160 "price_decimal": "foo" 161 } 162 }, 163 "value_numeric": 42, 164 "value_trait": { 165 "created_at": "foo", 166 "display_name": "foo", 167 "entity_type": "foo", 168 "hierarchy": [ 169 "foo" 170 ], 171 "id": "foo", 172 "trait_type": "foo", 173 "updated_at": "foo" 174 }, 175 "value_trait_id": "foo" 176 }, 177 "params": {} 178 }

Path parameters

plan_entitlement_idstringRequired

plan_entitlement_id

Request

This endpoint expects an object.

price_tierslist of objectsRequired

tier_modestringRequired

value_typeenumRequired

Allowed values:

credit_consumption_ratedouble or nullOptional

currencystring or nullOptional

metric_periodenum or nullOptional

Allowed values:

metric_period_month_resetenum or nullOptional

Allowed values:

monthly_metered_price_idstring or nullOptional

monthly_unit_priceinteger or nullOptional

monthly_unit_price_decimalstring or nullOptional

overage_billing_product_idstring or nullOptional

price_behaviorenum or nullOptional

Allowed values:

soft_limitinteger or nullOptional

value_boolboolean or nullOptional

value_credit_idstring or nullOptional

value_numericinteger or nullOptional

value_trait_idstring or nullOptional

yearly_metered_price_idstring or nullOptional

yearly_unit_priceinteger or nullOptional

yearly_unit_price_decimalstring or nullOptional

Response

dataobject

paramsobject

Input parameters

Update plan entitlement

Path parameters

Headers

Request

Response

Errors