1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. AccountSubscription
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

cloudflare.AccountSubscription

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    resources:
      exampleAccountSubscription:
        type: cloudflare:AccountSubscription
        name: example_account_subscription
        properties:
          accountId: 023e105f4ecef8ad9ca31a8372d0c353
          frequency: monthly
          ratePlan:
            id: free
            currency: USD
            externally_managed: false
            is_contract: false
            public_name: Business Plan
            scope: zone
            sets:
              - string
    

    Create AccountSubscription Resource

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

    Constructor syntax

    new AccountSubscription(name: string, args: AccountSubscriptionArgs, opts?: CustomResourceOptions);
    @overload
    def AccountSubscription(resource_name: str,
                            args: AccountSubscriptionArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def AccountSubscription(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            account_id: Optional[str] = None,
                            frequency: Optional[str] = None,
                            rate_plan: Optional[AccountSubscriptionRatePlanArgs] = None,
                            subscription_identifier: Optional[str] = None)
    func NewAccountSubscription(ctx *Context, name string, args AccountSubscriptionArgs, opts ...ResourceOption) (*AccountSubscription, error)
    public AccountSubscription(string name, AccountSubscriptionArgs args, CustomResourceOptions? opts = null)
    public AccountSubscription(String name, AccountSubscriptionArgs args)
    public AccountSubscription(String name, AccountSubscriptionArgs args, CustomResourceOptions options)
    
    type: cloudflare:AccountSubscription
    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 AccountSubscriptionArgs
    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 AccountSubscriptionArgs
    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 AccountSubscriptionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccountSubscriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccountSubscriptionArgs
    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 accountSubscriptionResource = new Cloudflare.AccountSubscription("accountSubscriptionResource", new()
    {
        AccountId = "string",
        Frequency = "string",
        RatePlan = new Cloudflare.Inputs.AccountSubscriptionRatePlanArgs
        {
            Currency = "string",
            ExternallyManaged = false,
            Id = "string",
            IsContract = false,
            PublicName = "string",
            Scope = "string",
            Sets = new[]
            {
                "string",
            },
        },
        SubscriptionIdentifier = "string",
    });
    
    example, err := cloudflare.NewAccountSubscription(ctx, "accountSubscriptionResource", &cloudflare.AccountSubscriptionArgs{
    	AccountId: pulumi.String("string"),
    	Frequency: pulumi.String("string"),
    	RatePlan: &cloudflare.AccountSubscriptionRatePlanArgs{
    		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"),
    		},
    	},
    	SubscriptionIdentifier: pulumi.String("string"),
    })
    
    var accountSubscriptionResource = new AccountSubscription("accountSubscriptionResource", AccountSubscriptionArgs.builder()
        .accountId("string")
        .frequency("string")
        .ratePlan(AccountSubscriptionRatePlanArgs.builder()
            .currency("string")
            .externallyManaged(false)
            .id("string")
            .isContract(false)
            .publicName("string")
            .scope("string")
            .sets("string")
            .build())
        .subscriptionIdentifier("string")
        .build());
    
    account_subscription_resource = cloudflare.AccountSubscription("accountSubscriptionResource",
        account_id="string",
        frequency="string",
        rate_plan={
            "currency": "string",
            "externally_managed": False,
            "id": "string",
            "is_contract": False,
            "public_name": "string",
            "scope": "string",
            "sets": ["string"],
        },
        subscription_identifier="string")
    
    const accountSubscriptionResource = new cloudflare.AccountSubscription("accountSubscriptionResource", {
        accountId: "string",
        frequency: "string",
        ratePlan: {
            currency: "string",
            externallyManaged: false,
            id: "string",
            isContract: false,
            publicName: "string",
            scope: "string",
            sets: ["string"],
        },
        subscriptionIdentifier: "string",
    });
    
    type: cloudflare:AccountSubscription
    properties:
        accountId: string
        frequency: string
        ratePlan:
            currency: string
            externallyManaged: false
            id: string
            isContract: false
            publicName: string
            scope: string
            sets:
                - string
        subscriptionIdentifier: string
    

    AccountSubscription 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 AccountSubscription resource accepts the following input properties:

    AccountId string
    Identifier
    Frequency string
    How often the subscription is renewed automatically. Available values: "weekly", "monthly", "quarterly", "yearly".
    RatePlan AccountSubscriptionRatePlan
    The rate plan applied to the subscription.
    SubscriptionIdentifier string
    Subscription identifier tag.
    AccountId string
    Identifier
    Frequency string
    How often the subscription is renewed automatically. Available values: "weekly", "monthly", "quarterly", "yearly".
    RatePlan AccountSubscriptionRatePlanArgs
    The rate plan applied to the subscription.
    SubscriptionIdentifier string
    Subscription identifier tag.
    accountId String
    Identifier
    frequency String
    How often the subscription is renewed automatically. Available values: "weekly", "monthly", "quarterly", "yearly".
    ratePlan AccountSubscriptionRatePlan
    The rate plan applied to the subscription.
    subscriptionIdentifier String
    Subscription identifier tag.
    accountId string
    Identifier
    frequency string
    How often the subscription is renewed automatically. Available values: "weekly", "monthly", "quarterly", "yearly".
    ratePlan AccountSubscriptionRatePlan
    The rate plan applied to the subscription.
    subscriptionIdentifier string
    Subscription identifier tag.
    account_id str
    Identifier
    frequency str
    How often the subscription is renewed automatically. Available values: "weekly", "monthly", "quarterly", "yearly".
    rate_plan AccountSubscriptionRatePlanArgs
    The rate plan applied to the subscription.
    subscription_identifier str
    Subscription identifier tag.
    accountId String
    Identifier
    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.
    subscriptionIdentifier String
    Subscription identifier tag.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AccountSubscription 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 AccountSubscription Resource

    Get an existing AccountSubscription 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?: AccountSubscriptionState, opts?: CustomResourceOptions): AccountSubscription
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = 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[AccountSubscriptionRatePlanArgs] = None,
            state: Optional[str] = None,
            subscription_identifier: Optional[str] = None) -> AccountSubscription
    func GetAccountSubscription(ctx *Context, name string, id IDInput, state *AccountSubscriptionState, opts ...ResourceOption) (*AccountSubscription, error)
    public static AccountSubscription Get(string name, Input<string> id, AccountSubscriptionState? state, CustomResourceOptions? opts = null)
    public static AccountSubscription get(String name, Output<String> id, AccountSubscriptionState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:AccountSubscription    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:
    AccountId string
    Identifier
    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 AccountSubscriptionRatePlan
    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".
    SubscriptionIdentifier string
    Subscription identifier tag.
    AccountId string
    Identifier
    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 AccountSubscriptionRatePlanArgs
    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".
    SubscriptionIdentifier string
    Subscription identifier tag.
    accountId String
    Identifier
    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 AccountSubscriptionRatePlan
    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".
    subscriptionIdentifier String
    Subscription identifier tag.
    accountId string
    Identifier
    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 AccountSubscriptionRatePlan
    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".
    subscriptionIdentifier string
    Subscription identifier tag.
    account_id str
    Identifier
    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 AccountSubscriptionRatePlanArgs
    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".
    subscription_identifier str
    Subscription identifier tag.
    accountId String
    Identifier
    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".
    subscriptionIdentifier String
    Subscription identifier tag.

    Supporting Types

    AccountSubscriptionRatePlan, AccountSubscriptionRatePlanArgs

    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.

    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.1.2 published on Monday, Apr 28, 2025 by Pulumi