Skip to content
Start here

Rate Plans

List Available Rate Plans
client.zones.ratePlans.get(RatePlanGetParams { zone_id } params, RequestOptionsoptions?): SinglePage<RatePlanGetResponse { id, components, currency, 3 more } >
GET/zones/{zone_id}/available_rate_plans
ModelsExpand Collapse
RatePlanGetResponse { id, components, currency, 3 more }
id?: string

Plan identifier tag.

components?: Array<Component>

Array of available components values for the plan.

default?: number

The default amount allocated.

name?: "zones" | "page_rules" | "dedicated_certificates" | "dedicated_certificates_custom"

The unique component.

One of the following:
"zones"
"page_rules"
"dedicated_certificates"
"dedicated_certificates_custom"
unit_price?: number

The unit price of the addon.

currency?: string

The monetary unit in which pricing information is displayed.

duration?: number

The duration of the plan subscription.

frequency?: "weekly" | "monthly" | "quarterly" | "yearly"

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

One of the following:
"weekly"
"monthly"
"quarterly"
"yearly"
name?: string

The plan name.

maxLength80