14 lines
10 KiB
Markdown
14 lines
10 KiB
Markdown
# CreateFeatureParams
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `name` | *str* | :heavy_check_mark: | The name of the feature. |
|
|
| `type` | [models.CreateFeatureTypeRequest](../models/createfeaturetyperequest.md) | :heavy_check_mark: | 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]* | :heavy_minus_sign: | 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.CreateFeatureDisplayRequest]](../models/createfeaturedisplayrequest.md) | :heavy_minus_sign: | Singular and plural display names for the feature in your user interface. |
|
|
| `credit_schema` | List[[models.CreateFeatureCreditSchemaRequest](../models/createfeaturecreditschemarequest.md)] | :heavy_minus_sign: | A schema that maps 'single_use' feature IDs to credit costs. Applicable only for 'credit_system' features. |
|
|
| `event_names` | List[*str*] | :heavy_minus_sign: | N/A |
|
|
| `feature_id` | *str* | :heavy_check_mark: | The ID of the feature to create. | |