Skip to content
Start here

Plans

List Available Plans
GET/zones/{zone_id}/available_plans
Available Plan Details
GET/zones/{zone_id}/available_plans/{plan_identifier}
ModelsExpand Collapse
AvailableRatePlan { id, can_subscribe, currency, 7 more }
id: optional string

Identifier

maxLength32
can_subscribe: optional boolean

Indicates whether you can subscribe to this plan.

currency: optional string

The monetary unit in which pricing information is displayed.

externally_managed: optional boolean

Indicates whether this plan is managed externally.

frequency: optional "weekly" or "monthly" or "quarterly" or "yearly"

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

One of the following:
"weekly"
"monthly"
"quarterly"
"yearly"
is_subscribed: optional boolean

Indicates whether you are currently subscribed to this plan.

legacy_discount: optional boolean

Indicates whether this plan has a legacy discount applied.

legacy_id: optional string

The legacy identifier for this rate plan, if any.

name: optional string

The plan name.

maxLength80
price: optional number

The amount you will be billed for this plan.