Skip to content
Cloudflare API
Start here
API Reference
Zones
Plans

Available Plan Details

zones.plans.get(strplan_identifier, PlanGetParams**kwargs) -> AvailableRatePlan
GET/zones/{zone_id}/available_plans/{plan_identifier}

Details of the available plan that the zone can subscribe to.

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
Billing WriteBilling Read
ParametersExpand Collapse
zone_id: str

Identifier

maxLength32
plan_identifier: str

Identifier

maxLength32
ReturnsExpand 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.

Available Plan Details

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
available_rate_plan = client.zones.plans.get(
    plan_identifier="023e105f4ecef8ad9ca31a8372d0c353",
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(available_rate_plan.id)
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "can_subscribe": true,
    "currency": "USD",
    "externally_managed": false,
    "frequency": "monthly",
    "is_subscribed": false,
    "legacy_discount": false,
    "legacy_id": "free",
    "name": "Free Plan",
    "price": 0
  },
  "success": true
}
Returns Examples
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "can_subscribe": true,
    "currency": "USD",
    "externally_managed": false,
    "frequency": "monthly",
    "is_subscribed": false,
    "legacy_discount": false,
    "legacy_id": "free",
    "name": "Free Plan",
    "price": 0
  },
  "success": true
}