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

5.7 KiB
Raw Blame History

UpdatePlanParams

Fields

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