plans
Creates, updates, deletes, gets or lists a plans resource.
Overview
| Name | plans |
| Type | Resource |
| Id | cloudflare.zones.plans |
Fields
The following fields are returned by SELECT queries:
- get
- list
Available Plan Details response
| Name | Datatype | Description |
|---|---|---|
id | string | Identifier (example: 023e105f4ecef8ad9ca31a8372d0c353) |
name | string | The plan name. (example: Free Plan) |
legacy_id | string | The legacy identifier for this rate plan, if any. (example: free) |
can_subscribe | boolean | Indicates whether you can subscribe to this plan. |
currency | string | The monetary unit in which pricing information is displayed. (example: USD) |
externally_managed | boolean | Indicates whether this plan is managed externally. |
frequency | string | The frequency at which you will be billed for this plan. (weekly, monthly, quarterly, yearly) (example: monthly) |
is_subscribed | boolean | Indicates whether you are currently subscribed to this plan. |
legacy_discount | boolean | Indicates whether this plan has a legacy discount applied. |
price | number | The amount you will be billed for this plan. |
List Available Plans response
| Name | Datatype | Description |
|---|---|---|
id | string | Identifier (example: 023e105f4ecef8ad9ca31a8372d0c353) |
name | string | The plan name. (example: Free Plan) |
legacy_id | string | The legacy identifier for this rate plan, if any. (example: free) |
can_subscribe | boolean | Indicates whether you can subscribe to this plan. |
currency | string | The monetary unit in which pricing information is displayed. (example: USD) |
externally_managed | boolean | Indicates whether this plan is managed externally. |
frequency | string | The frequency at which you will be billed for this plan. (weekly, monthly, quarterly, yearly) (example: monthly) |
is_subscribed | boolean | Indicates whether you are currently subscribed to this plan. |
legacy_discount | boolean | Indicates whether this plan has a legacy discount applied. |
price | number | The amount you will be billed for this plan. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | plan_identifier, zone_id | Details of the available plan that the zone can subscribe to. | |
list | select | zone_id | Lists available plans the zone can subscribe to. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
plan_identifier | string | |
zone_id | string | The Cloudflare zone ID. |
SELECT examples
- get
- list
Details of the available plan that the zone can subscribe to.
SELECT
id,
name,
legacy_id,
can_subscribe,
currency,
externally_managed,
frequency,
is_subscribed,
legacy_discount,
price
FROM cloudflare.zones.plans
WHERE plan_identifier = '{{ plan_identifier }}' -- required
AND zone_id = '{{ zone_id }}' -- required
;
Lists available plans the zone can subscribe to.
SELECT
id,
name,
legacy_id,
can_subscribe,
currency,
externally_managed,
frequency,
is_subscribed,
legacy_discount,
price
FROM cloudflare.zones.plans
WHERE zone_id = '{{ zone_id }}' -- required
;