12 KiB
12 KiB
UpdateFeatureParams
Fields
| Field | Type | Required | Description |
|---|---|---|---|
name |
Optional[str] | ➖ | The name of the feature. |
type |
Optional[models.UpdateFeatureTypeRequest] | ➖ | The type of the feature. 'single_use' features are consumed, like API calls, tokens, or messages. 'continuous_use' features are allocated, like seats, workspaces, or projects. 'credit_system' features are schemas that unify multiple 'single_use' features into a single credit system. |
consumable |
Optional[bool] | ➖ | Whether this feature is consumable. A consumable feature is one that periodically resets and is consumed rather than allocated (like credits, API requests, etc.). Applicable only for 'metered' features. |
display |
Optional[models.UpdateFeatureDisplayRequest] | ➖ | Singular and plural display names for the feature in your user interface. |
credit_schema |
List[models.UpdateFeatureCreditSchemaRequest] | ➖ | A schema that maps 'single_use' feature IDs to credit costs. Applicable only for 'credit_system' features. |
event_names |
List[str] | ➖ | N/A |
archived |
Optional[bool] | ➖ | Whether the feature is archived. Archived features are hidden from the dashboard. |
feature_id |
str | ✔️ | The ID of the feature to update. |
new_feature_id |
Optional[str] | ➖ | The new ID of the feature. Feature ID can only be updated if it's not being used by any customers. |