# UpdatePlanParams


## Fields

| Field                                                                                                | Type                                                                                                 | Required                                                                                             | Description                                                                                          |
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `plan_id`                                                                                            | *str*                                                                                                | :heavy_check_mark:                                                                                   | The ID of the plan to update.                                                                        |
| `group`                                                                                              | *Optional[str]*                                                                                      | :heavy_minus_sign:                                                                                   | Group identifier for organizing related plans. Plans in the same group are mutually exclusive.       |
| `name`                                                                                               | *Optional[str]*                                                                                      | :heavy_minus_sign:                                                                                   | Display name of the plan.                                                                            |
| `description`                                                                                        | *Optional[str]*                                                                                      | :heavy_minus_sign:                                                                                   | N/A                                                                                                  |
| `add_on`                                                                                             | *Optional[bool]*                                                                                     | :heavy_minus_sign:                                                                                   | Whether the plan is an add-on.                                                                       |
| `auto_enable`                                                                                        | *Optional[bool]*                                                                                     | :heavy_minus_sign:                                                                                   | Whether the plan is automatically enabled.                                                           |
| `price`                                                                                              | [OptionalNullable[models.UpdatePlanPriceRequest]](../models/updateplanpricerequest.md)               | :heavy_minus_sign:                                                                                   | The price of the plan. Set to null to remove the base price.                                         |
| `items`                                                                                              | List[[models.UpdatePlanItemRequest](../models/updateplanitemrequest.md)]                             | :heavy_minus_sign:                                                                                   | Feature configurations for this plan. Each item defines included units, pricing, and reset behavior. |
| `free_trial`                                                                                         | [OptionalNullable[models.UpdatePlanFreeTrialRequest]](../models/updateplanfreetrialrequest.md)       | :heavy_minus_sign:                                                                                   | The free trial of the plan. Set to null to remove the free trial.                                    |
| `version`                                                                                            | *Optional[float]*                                                                                    | :heavy_minus_sign:                                                                                   | N/A                                                                                                  |
| `archived`                                                                                           | *Optional[bool]*                                                                                     | :heavy_minus_sign:                                                                                   | N/A                                                                                                  |
| `new_plan_id`                                                                                        | *Optional[str]*                                                                                      | :heavy_minus_sign:                                                                                   | The new ID to use for the plan. Can only be updated if the plan has not been used by any customers.  |