16 lines
5.4 KiB
Markdown
16 lines
5.4 KiB
Markdown
# CreatePlanParams
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
|
| `plan_id` | *str* | :heavy_check_mark: | The ID of the plan to create. |
|
|
| `group` | *Optional[str]* | :heavy_minus_sign: | Group identifier for organizing related plans. Plans in the same group are mutually exclusive. |
|
|
| `name` | *str* | :heavy_check_mark: | Display name of the plan. |
|
|
| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional description of the plan. |
|
|
| `add_on` | *Optional[bool]* | :heavy_minus_sign: | If true, this plan can be attached alongside other plans. Otherwise, attaching replaces existing plans in the same group. |
|
|
| `auto_enable` | *Optional[bool]* | :heavy_minus_sign: | If true, plan is automatically attached when a customer is created. Use for free tiers. |
|
|
| `price` | [Optional[models.CreatePlanPriceRequest]](../models/createplanpricerequest.md) | :heavy_minus_sign: | Base recurring price for the plan. Omit for free or usage-only plans. |
|
|
| `items` | List[[models.CreatePlanItemRequest](../models/createplanitemrequest.md)] | :heavy_minus_sign: | Feature configurations for this plan. Each item defines included units, pricing, and reset behavior. |
|
|
| `free_trial` | [Optional[models.CreatePlanFreeTrialRequest]](../models/createplanfreetrialrequest.md) | :heavy_minus_sign: | Free trial configuration. Customers can try this plan before being charged. | |