Skip to content
Start here

Plans

List Available Plans
client.zones.plans.list(PlanListParams { zone_id } params, RequestOptionsoptions?): SinglePage<AvailableRatePlan { id, can_subscribe, currency, 7 more } >
GET/zones/{zone_id}/available_plans
Available Plan Details
client.zones.plans.get(stringplanIdentifier, PlanGetParams { zone_id } params, RequestOptionsoptions?): AvailableRatePlan { id, can_subscribe, currency, 7 more }
GET/zones/{zone_id}/available_plans/{plan_identifier}
ModelsExpand Collapse
AvailableRatePlan { id, can_subscribe, currency, 7 more }
id?: string

Identifier

maxLength32
can_subscribe?: boolean

Indicates whether you can subscribe to this plan.

currency?: string

The monetary unit in which pricing information is displayed.

externally_managed?: boolean

Indicates whether this plan is managed externally.

frequency?: "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?: boolean

Indicates whether you are currently subscribed to this plan.

legacy_discount?: boolean

Indicates whether this plan has a legacy discount applied.

legacy_id?: string

The legacy identifier for this rate plan, if any.

name?: string

The plan name.

maxLength80
price?: number

The amount you will be billed for this plan.