Skip to content
Start here

Plans

List Available Plans
zones.plans.list(PlanListParams**kwargs) -> SyncSinglePage[AvailableRatePlan]
GET/zones/{zone_id}/available_plans
Available Plan Details
zones.plans.get(strplan_identifier, PlanGetParams**kwargs) -> AvailableRatePlan
GET/zones/{zone_id}/available_plans/{plan_identifier}
ModelsExpand Collapse
class AvailableRatePlan:
id: Optional[str]

Identifier

maxLength32
can_subscribe: Optional[bool]

Indicates whether you can subscribe to this plan.

currency: Optional[str]

The monetary unit in which pricing information is displayed.

externally_managed: Optional[bool]

Indicates whether this plan is managed externally.

frequency: Optional[Literal["weekly", "monthly", "quarterly", "yearly"]]

The frequency at which you will be billed for this plan.

One of the following:
"weekly"
"monthly"
"quarterly"
"yearly"
is_subscribed: Optional[bool]

Indicates whether you are currently subscribed to this plan.

legacy_discount: Optional[bool]

Indicates whether this plan has a legacy discount applied.

legacy_id: Optional[str]

The legacy identifier for this rate plan, if any.

name: Optional[str]

The plan name.

maxLength80
price: Optional[float]

The amount you will be billed for this plan.