Files
cfw-autumn/others/python-sdk/docs/models/createplanparams.md
2026-02-19 16:05:43 +00:00

5.4 KiB
Raw Blame History

CreatePlanParams

Fields

Field Type Required Description
plan_id str ✔️ The ID of the plan to create.
group Optional[str] ➖ Group identifier for organizing related plans. Plans in the same group are mutually exclusive.
name str ✔️ Display name of the plan.
description OptionalNullable[str] ➖ Optional description of the plan.
add_on Optional[bool] ➖ If true, this plan can be attached alongside other plans. Otherwise, attaching replaces existing plans in the same group.
auto_enable Optional[bool] ➖ If true, plan is automatically attached when a customer is created. Use for free tiers.
price Optional[models.CreatePlanPriceRequest] ➖ Base recurring price for the plan. Omit for free or usage-only plans.
items List[models.CreatePlanItemRequest] ➖ Feature configurations for this plan. Each item defines included units, pricing, and reset behavior.
free_trial Optional[models.CreatePlanFreeTrialRequest] ➖ Free trial configuration. Customers can try this plan before being charged.