22 lines
5.0 KiB
Markdown
22 lines
5.0 KiB
Markdown
# Plan
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
|
| `id` | *str* | :heavy_check_mark: | N/A |
|
|
| `name` | *str* | :heavy_check_mark: | N/A |
|
|
| `description` | *Nullable[str]* | :heavy_check_mark: | N/A |
|
|
| `group` | *Nullable[str]* | :heavy_check_mark: | N/A |
|
|
| `version` | *float* | :heavy_check_mark: | N/A |
|
|
| `add_on` | *bool* | :heavy_check_mark: | N/A |
|
|
| `auto_enable` | *bool* | :heavy_check_mark: | N/A |
|
|
| `price` | [Nullable[models.PlanPrice]](../models/planprice.md) | :heavy_check_mark: | N/A |
|
|
| `items` | List[[models.Item](../models/item.md)] | :heavy_check_mark: | N/A |
|
|
| `free_trial` | [Optional[models.FreeTrial]](../models/freetrial.md) | :heavy_minus_sign: | N/A |
|
|
| `created_at` | *float* | :heavy_check_mark: | N/A |
|
|
| `env` | [models.PlanEnv](../models/planenv.md) | :heavy_check_mark: | N/A |
|
|
| `archived` | *bool* | :heavy_check_mark: | N/A |
|
|
| `base_variant_id` | *Nullable[str]* | :heavy_check_mark: | N/A |
|
|
| `customer_eligibility` | [Optional[models.CustomerEligibility]](../models/customereligibility.md) | :heavy_minus_sign: | N/A | |