Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. ZoneSubscription
Cloudflare v6.6.0 published on Wednesday, Aug 20, 2025 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.ZoneSubscription

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.6.0 published on Wednesday, Aug 20, 2025 by Pulumi
pulumi/pulumi-cloudflare

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  exampleZoneSubscription:
    type: cloudflare:ZoneSubscription
    name: example_zone_subscription
    properties:
      zoneId: 506e3185e9c882d175a2d0cb0093d9f2
      frequency: monthly
      ratePlan:
        id: free
        currency: USD
        externally_managed: false
        is_contract: false
        public_name: Business Plan
        scope: zone
        sets:
          - string

    Create ZoneSubscription Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ZoneSubscription(name: string, args: ZoneSubscriptionArgs, opts?: CustomResourceOptions);
    @overload
def ZoneSubscription(resource_name: str,
                     args: ZoneSubscriptionArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def ZoneSubscription(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     zone_id: Optional[str] = None,
                     frequency: Optional[str] = None,
                     rate_plan: Optional[ZoneSubscriptionRatePlanArgs] = None)
    func NewZoneSubscription(ctx *Context, name string, args ZoneSubscriptionArgs, opts ...ResourceOption) (*ZoneSubscription, error)
    public ZoneSubscription(string name, ZoneSubscriptionArgs args, CustomResourceOptions? opts = null)
    public ZoneSubscription(String name, ZoneSubscriptionArgs args)
public ZoneSubscription(String name, ZoneSubscriptionArgs args, CustomResourceOptions options)

    type: cloudflare:ZoneSubscription
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ZoneSubscriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ZoneSubscriptionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ZoneSubscriptionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ZoneSubscriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ZoneSubscriptionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var zoneSubscriptionResource = new Cloudflare.ZoneSubscription("zoneSubscriptionResource", new()
{
    ZoneId = "string",
    Frequency = "string",
    RatePlan = new Cloudflare.Inputs.ZoneSubscriptionRatePlanArgs
    {
        Currency = "string",
        ExternallyManaged = false,
        Id = "string",
        IsContract = false,
        PublicName = "string",
        Scope = "string",
        Sets = new[]
        {
            "string",
        },
    },
});

    example, err := cloudflare.NewZoneSubscription(ctx, "zoneSubscriptionResource", &cloudflare.ZoneSubscriptionArgs{
	ZoneId:    pulumi.String("string"),
	Frequency: pulumi.String("string"),
	RatePlan: &cloudflare.ZoneSubscriptionRatePlanArgs{
		Currency:          pulumi.String("string"),
		ExternallyManaged: pulumi.Bool(false),
		Id:                pulumi.String("string"),
		IsContract:        pulumi.Bool(false),
		PublicName:        pulumi.String("string"),
		Scope:             pulumi.String("string"),
		Sets: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
})

    var zoneSubscriptionResource = new ZoneSubscription("zoneSubscriptionResource", ZoneSubscriptionArgs.builder()
    .zoneId("string")
    .frequency("string")
    .ratePlan(ZoneSubscriptionRatePlanArgs.builder()
        .currency("string")
        .externallyManaged(false)
        .id("string")
        .isContract(false)
        .publicName("string")
        .scope("string")
        .sets("string")
        .build())
    .build());

    zone_subscription_resource = cloudflare.ZoneSubscription("zoneSubscriptionResource",
    zone_id="string",
    frequency="string",
    rate_plan={
        "currency": "string",
        "externally_managed": False,
        "id": "string",
        "is_contract": False,
        "public_name": "string",
        "scope": "string",
        "sets": ["string"],
    })

    const zoneSubscriptionResource = new cloudflare.ZoneSubscription("zoneSubscriptionResource", {
    zoneId: "string",
    frequency: "string",
    ratePlan: {
        currency: "string",
        externallyManaged: false,
        id: "string",
        isContract: false,
        publicName: "string",
        scope: "string",
        sets: ["string"],
    },
});

    type: cloudflare:ZoneSubscription
properties:
    frequency: string
    ratePlan:
        currency: string
        externallyManaged: false
        id: string
        isContract: false
        publicName: string
        scope: string
        sets:
            - string
    zoneId: string

    ZoneSubscription Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ZoneSubscription resource accepts the following input properties:

    ZoneId string
    Subscription identifier tag.
    Frequency string
    How often the subscription is renewed automatically. Available values: "weekly", "monthly", "quarterly", "yearly".
    RatePlan ZoneSubscriptionRatePlan
    The rate plan applied to the subscription.
    ZoneId string
    Subscription identifier tag.
    Frequency string
    How often the subscription is renewed automatically. Available values: "weekly", "monthly", "quarterly", "yearly".
    RatePlan ZoneSubscriptionRatePlanArgs
    The rate plan applied to the subscription.
    zoneId String
    Subscription identifier tag.
    frequency String
    How often the subscription is renewed automatically. Available values: "weekly", "monthly", "quarterly", "yearly".
    ratePlan ZoneSubscriptionRatePlan
    The rate plan applied to the subscription.
    zoneId string
    Subscription identifier tag.
    frequency string
    How often the subscription is renewed automatically. Available values: "weekly", "monthly", "quarterly", "yearly".
    ratePlan ZoneSubscriptionRatePlan
    The rate plan applied to the subscription.
    zone_id str
    Subscription identifier tag.
    frequency str
    How often the subscription is renewed automatically. Available values: "weekly", "monthly", "quarterly", "yearly".
    rate_plan ZoneSubscriptionRatePlanArgs
    The rate plan applied to the subscription.
    zoneId String
    Subscription identifier tag.
    frequency String
    How often the subscription is renewed automatically. Available values: "weekly", "monthly", "quarterly", "yearly".
    ratePlan Property Map
    The rate plan applied to the subscription.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ZoneSubscription resource produces the following output properties:

    Currency string
    The monetary unit in which pricing information is displayed.
    CurrentPeriodEnd string
    The end of the current period and also when the next billing is due.
    CurrentPeriodStart string
    When the current billing period started. May match initialperiodstart if this is the first period.
    Id string
    The provider-assigned unique ID for this managed resource.
    Price double
    The price of the subscription that will be billed, in US dollars.
    State string
    The state that the subscription is in. Available values: "Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired".
    Currency string
    The monetary unit in which pricing information is displayed.
    CurrentPeriodEnd string
    The end of the current period and also when the next billing is due.
    CurrentPeriodStart string
    When the current billing period started. May match initialperiodstart if this is the first period.
    Id string
    The provider-assigned unique ID for this managed resource.
    Price float64
    The price of the subscription that will be billed, in US dollars.
    State string
    The state that the subscription is in. Available values: "Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired".
    currency String
    The monetary unit in which pricing information is displayed.
    currentPeriodEnd String
    The end of the current period and also when the next billing is due.
    currentPeriodStart String
    When the current billing period started. May match initialperiodstart if this is the first period.
    id String
    The provider-assigned unique ID for this managed resource.
    price Double
    The price of the subscription that will be billed, in US dollars.
    state String
    The state that the subscription is in. Available values: "Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired".
    currency string
    The monetary unit in which pricing information is displayed.
    currentPeriodEnd string
    The end of the current period and also when the next billing is due.
    currentPeriodStart string
    When the current billing period started. May match initialperiodstart if this is the first period.
    id string
    The provider-assigned unique ID for this managed resource.
    price number
    The price of the subscription that will be billed, in US dollars.
    state string
    The state that the subscription is in. Available values: "Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired".
    currency str
    The monetary unit in which pricing information is displayed.
    current_period_end str
    The end of the current period and also when the next billing is due.
    current_period_start str
    When the current billing period started. May match initialperiodstart if this is the first period.
    id str
    The provider-assigned unique ID for this managed resource.
    price float
    The price of the subscription that will be billed, in US dollars.
    state str
    The state that the subscription is in. Available values: "Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired".
    currency String
    The monetary unit in which pricing information is displayed.
    currentPeriodEnd String
    The end of the current period and also when the next billing is due.
    currentPeriodStart String
    When the current billing period started. May match initialperiodstart if this is the first period.
    id String
    The provider-assigned unique ID for this managed resource.
    price Number
    The price of the subscription that will be billed, in US dollars.
    state String
    The state that the subscription is in. Available values: "Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired".

    Look up Existing ZoneSubscription Resource

    Get an existing ZoneSubscription resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ZoneSubscriptionState, opts?: CustomResourceOptions): ZoneSubscription
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        currency: Optional[str] = None,
        current_period_end: Optional[str] = None,
        current_period_start: Optional[str] = None,
        frequency: Optional[str] = None,
        price: Optional[float] = None,
        rate_plan: Optional[ZoneSubscriptionRatePlanArgs] = None,
        state: Optional[str] = None,
        zone_id: Optional[str] = None) -> ZoneSubscription
    func GetZoneSubscription(ctx *Context, name string, id IDInput, state *ZoneSubscriptionState, opts ...ResourceOption) (*ZoneSubscription, error)
    public static ZoneSubscription Get(string name, Input<string> id, ZoneSubscriptionState? state, CustomResourceOptions? opts = null)
    public static ZoneSubscription get(String name, Output<String> id, ZoneSubscriptionState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:ZoneSubscription    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Currency string
    The monetary unit in which pricing information is displayed.
    CurrentPeriodEnd string
    The end of the current period and also when the next billing is due.
    CurrentPeriodStart string
    When the current billing period started. May match initialperiodstart if this is the first period.
    Frequency string
    How often the subscription is renewed automatically. Available values: "weekly", "monthly", "quarterly", "yearly".
    Price double
    The price of the subscription that will be billed, in US dollars.
    RatePlan ZoneSubscriptionRatePlan
    The rate plan applied to the subscription.
    State string
    The state that the subscription is in. Available values: "Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired".
    ZoneId string
    Subscription identifier tag.
    Currency string
    The monetary unit in which pricing information is displayed.
    CurrentPeriodEnd string
    The end of the current period and also when the next billing is due.
    CurrentPeriodStart string
    When the current billing period started. May match initialperiodstart if this is the first period.
    Frequency string
    How often the subscription is renewed automatically. Available values: "weekly", "monthly", "quarterly", "yearly".
    Price float64
    The price of the subscription that will be billed, in US dollars.
    RatePlan ZoneSubscriptionRatePlanArgs
    The rate plan applied to the subscription.
    State string
    The state that the subscription is in. Available values: "Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired".
    ZoneId string
    Subscription identifier tag.
    currency String
    The monetary unit in which pricing information is displayed.
    currentPeriodEnd String
    The end of the current period and also when the next billing is due.
    currentPeriodStart String
    When the current billing period started. May match initialperiodstart if this is the first period.
    frequency String
    How often the subscription is renewed automatically. Available values: "weekly", "monthly", "quarterly", "yearly".
    price Double
    The price of the subscription that will be billed, in US dollars.
    ratePlan ZoneSubscriptionRatePlan
    The rate plan applied to the subscription.
    state String
    The state that the subscription is in. Available values: "Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired".
    zoneId String
    Subscription identifier tag.
    currency string
    The monetary unit in which pricing information is displayed.
    currentPeriodEnd string
    The end of the current period and also when the next billing is due.
    currentPeriodStart string
    When the current billing period started. May match initialperiodstart if this is the first period.
    frequency string
    How often the subscription is renewed automatically. Available values: "weekly", "monthly", "quarterly", "yearly".
    price number
    The price of the subscription that will be billed, in US dollars.
    ratePlan ZoneSubscriptionRatePlan
    The rate plan applied to the subscription.
    state string
    The state that the subscription is in. Available values: "Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired".
    zoneId string
    Subscription identifier tag.
    currency str
    The monetary unit in which pricing information is displayed.
    current_period_end str
    The end of the current period and also when the next billing is due.
    current_period_start str
    When the current billing period started. May match initialperiodstart if this is the first period.
    frequency str
    How often the subscription is renewed automatically. Available values: "weekly", "monthly", "quarterly", "yearly".
    price float
    The price of the subscription that will be billed, in US dollars.
    rate_plan ZoneSubscriptionRatePlanArgs
    The rate plan applied to the subscription.
    state str
    The state that the subscription is in. Available values: "Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired".
    zone_id str
    Subscription identifier tag.
    currency String
    The monetary unit in which pricing information is displayed.
    currentPeriodEnd String
    The end of the current period and also when the next billing is due.
    currentPeriodStart String
    When the current billing period started. May match initialperiodstart if this is the first period.
    frequency String
    How often the subscription is renewed automatically. Available values: "weekly", "monthly", "quarterly", "yearly".
    price Number
    The price of the subscription that will be billed, in US dollars.
    ratePlan Property Map
    The rate plan applied to the subscription.
    state String
    The state that the subscription is in. Available values: "Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired".
    zoneId String
    Subscription identifier tag.

    Supporting Types

    ZoneSubscriptionRatePlan, ZoneSubscriptionRatePlanArgs

    Currency string
    The currency applied to the rate plan subscription.
    ExternallyManaged bool
    Whether this rate plan is managed externally from Cloudflare.
    Id string
    The ID of the rate plan. Available values: "free", "lite", "pro", "proplus", "business", "enterprise", "partnersfree", "partnerspro", "partnersbusiness", "partners_enterprise".
    IsContract bool
    Whether a rate plan is enterprise-based (or newly adopted term contract).
    PublicName string
    The full name of the rate plan.
    Scope string
    The scope that this rate plan applies to.
    Sets List<string>
    The list of sets this rate plan applies to.
    Currency string
    The currency applied to the rate plan subscription.
    ExternallyManaged bool
    Whether this rate plan is managed externally from Cloudflare.
    Id string
    The ID of the rate plan. Available values: "free", "lite", "pro", "proplus", "business", "enterprise", "partnersfree", "partnerspro", "partnersbusiness", "partners_enterprise".
    IsContract bool
    Whether a rate plan is enterprise-based (or newly adopted term contract).
    PublicName string
    The full name of the rate plan.
    Scope string
    The scope that this rate plan applies to.
    Sets []string
    The list of sets this rate plan applies to.
    currency String
    The currency applied to the rate plan subscription.
    externallyManaged Boolean
    Whether this rate plan is managed externally from Cloudflare.
    id String
    The ID of the rate plan. Available values: "free", "lite", "pro", "proplus", "business", "enterprise", "partnersfree", "partnerspro", "partnersbusiness", "partners_enterprise".
    isContract Boolean
    Whether a rate plan is enterprise-based (or newly adopted term contract).
    publicName String
    The full name of the rate plan.
    scope String
    The scope that this rate plan applies to.
    sets List<String>
    The list of sets this rate plan applies to.
    currency string
    The currency applied to the rate plan subscription.
    externallyManaged boolean
    Whether this rate plan is managed externally from Cloudflare.
    id string
    The ID of the rate plan. Available values: "free", "lite", "pro", "proplus", "business", "enterprise", "partnersfree", "partnerspro", "partnersbusiness", "partners_enterprise".
    isContract boolean
    Whether a rate plan is enterprise-based (or newly adopted term contract).
    publicName string
    The full name of the rate plan.
    scope string
    The scope that this rate plan applies to.
    sets string[]
    The list of sets this rate plan applies to.
    currency str
    The currency applied to the rate plan subscription.
    externally_managed bool
    Whether this rate plan is managed externally from Cloudflare.
    id str
    The ID of the rate plan. Available values: "free", "lite", "pro", "proplus", "business", "enterprise", "partnersfree", "partnerspro", "partnersbusiness", "partners_enterprise".
    is_contract bool
    Whether a rate plan is enterprise-based (or newly adopted term contract).
    public_name str
    The full name of the rate plan.
    scope str
    The scope that this rate plan applies to.
    sets Sequence[str]
    The list of sets this rate plan applies to.
    currency String
    The currency applied to the rate plan subscription.
    externallyManaged Boolean
    Whether this rate plan is managed externally from Cloudflare.
    id String
    The ID of the rate plan. Available values: "free", "lite", "pro", "proplus", "business", "enterprise", "partnersfree", "partnerspro", "partnersbusiness", "partners_enterprise".
    isContract Boolean
    Whether a rate plan is enterprise-based (or newly adopted term contract).
    publicName String
    The full name of the rate plan.
    scope String
    The scope that this rate plan applies to.
    sets List<String>
    The list of sets this rate plan applies to.

    Import

    $ pulumi import cloudflare:index/zoneSubscription:ZoneSubscription example '<zone_id>'

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v6.6.0 published on Wednesday, Aug 20, 2025 by Pulumi
    pulumi/pulumi-cloudflare