PUT
/
plan-entitlements
/
{plan_entitlement_id}
curl --request PUT \
  --url https://api.schematichq.com/plan-entitlements/{plan_entitlement_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Schematic-Api-Key: <api-key>' \
  --data '{
  "metric_period": "current_month",
  "value_bool": true,
  "value_numeric": 123,
  "value_trait_id": "<string>",
  "value_type": "boolean"
}'
{
  "data": {
    "created_at": "2023-11-07T05:31:56Z",
    "environment_id": "<string>",
    "feature": {
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "event_subtype": "<string>",
      "feature_type": "<string>",
      "id": "<string>",
      "lifecycle_phase": "<string>",
      "name": "<string>",
      "trait_id": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "feature_id": "<string>",
    "id": "<string>",
    "metric_period": "<string>",
    "plan": {
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "id": "<string>",
      "name": "<string>",
      "plan_type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "plan_id": "<string>",
    "rule_id": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "value_bool": true,
    "value_numeric": 123,
    "value_trait": {
      "created_at": "2023-11-07T05:31:56Z",
      "display_name": "<string>",
      "entity_type": "<string>",
      "hierarchy": [
        "<string>"
      ],
      "id": "<string>",
      "trait_type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "value_trait_id": "<string>",
    "value_type": "<string>"
  },
  "params": {}
}

Authorizations

X-Schematic-Api-Key
string
headerrequired

Path Parameters

plan_entitlement_id
string
required

plan_entitlement_id

Body

application/json
metric_period
enum<string> | null
Available options:
current_month,
current_week,
current_day
value_bool
boolean | null
value_numeric
integer | null
value_trait_id
string | null
value_type
enum<string>
required
Available options:
boolean,
numeric,
trait,
unlimited

Response

200 - application/json
data
object
required

The updated resource

params
object
required

Input parameters