1. Registry
  2. Packages
  3. Stripe Provider
  4. API Docs
  5. EntitlementsFeature
Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi

    A feature represents a monetizable ability or functionality in your system. Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.

    Create EntitlementsFeature Resource

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

    Constructor syntax

    new EntitlementsFeature(name: string, args: EntitlementsFeatureArgs, opts?: CustomResourceOptions);
    @overload
    def EntitlementsFeature(resource_name: str,
                            args: EntitlementsFeatureArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def EntitlementsFeature(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            lookup_key: Optional[str] = None,
                            metadata: Optional[Mapping[str, str]] = None,
                            name: Optional[str] = None)
    func NewEntitlementsFeature(ctx *Context, name string, args EntitlementsFeatureArgs, opts ...ResourceOption) (*EntitlementsFeature, error)
    public EntitlementsFeature(string name, EntitlementsFeatureArgs args, CustomResourceOptions? opts = null)
    public EntitlementsFeature(String name, EntitlementsFeatureArgs args)
    public EntitlementsFeature(String name, EntitlementsFeatureArgs args, CustomResourceOptions options)
    
    type: stripe:EntitlementsFeature
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "stripe_entitlements_feature" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args EntitlementsFeatureArgs
    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 EntitlementsFeatureArgs
    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 EntitlementsFeatureArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EntitlementsFeatureArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EntitlementsFeatureArgs
    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 entitlementsFeatureResource = new Stripe.EntitlementsFeature("entitlementsFeatureResource", new()
    {
        LookupKey = "string",
        Metadata = 
        {
            { "string", "string" },
        },
        Name = "string",
    });
    
    example, err := stripe.NewEntitlementsFeature(ctx, "entitlementsFeatureResource", &stripe.EntitlementsFeatureArgs{
    	LookupKey: pulumi.String("string"),
    	Metadata: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    })
    
    resource "stripe_entitlements_feature" "entitlementsFeatureResource" {
      lifecycle {
        create_before_destroy = true
      }
      lookup_key = "string"
      metadata = {
        "string" = "string"
      }
      name = "string"
    }
    
    var entitlementsFeatureResource = new EntitlementsFeature("entitlementsFeatureResource", EntitlementsFeatureArgs.builder()
        .lookupKey("string")
        .metadata(Map.of("string", "string"))
        .name("string")
        .build());
    
    entitlements_feature_resource = stripe.EntitlementsFeature("entitlementsFeatureResource",
        lookup_key="string",
        metadata={
            "string": "string",
        },
        name="string")
    
    const entitlementsFeatureResource = new stripe.EntitlementsFeature("entitlementsFeatureResource", {
        lookupKey: "string",
        metadata: {
            string: "string",
        },
        name: "string",
    });
    
    type: stripe:EntitlementsFeature
    properties:
        lookupKey: string
        metadata:
            string: string
        name: string
    

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

    LookupKey string
    A unique key you provide as your own system identifier. This may be up to 80 characters.
    Metadata Dictionary<string, string>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    Name string
    The feature's name, for your own purpose, not meant to be displayable to the customer.
    LookupKey string
    A unique key you provide as your own system identifier. This may be up to 80 characters.
    Metadata map[string]string
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    Name string
    The feature's name, for your own purpose, not meant to be displayable to the customer.
    lookup_key string
    A unique key you provide as your own system identifier. This may be up to 80 characters.
    metadata map(string)
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    name string
    The feature's name, for your own purpose, not meant to be displayable to the customer.
    lookupKey String
    A unique key you provide as your own system identifier. This may be up to 80 characters.
    metadata Map<String,String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    name String
    The feature's name, for your own purpose, not meant to be displayable to the customer.
    lookupKey string
    A unique key you provide as your own system identifier. This may be up to 80 characters.
    metadata {[key: string]: string}
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    name string
    The feature's name, for your own purpose, not meant to be displayable to the customer.
    lookup_key str
    A unique key you provide as your own system identifier. This may be up to 80 characters.
    metadata Mapping[str, str]
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    name str
    The feature's name, for your own purpose, not meant to be displayable to the customer.
    lookupKey String
    A unique key you provide as your own system identifier. This may be up to 80 characters.
    metadata Map<String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    name String
    The feature's name, for your own purpose, not meant to be displayable to the customer.

    Outputs

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

    Active bool
    Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Active bool
    Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    active bool
    Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
    id string
    The provider-assigned unique ID for this managed resource.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object string
    String representing the object's type. Objects of the same type share the same value.
    active Boolean
    Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object String
    String representing the object's type. Objects of the same type share the same value.
    active boolean
    Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
    id string
    The provider-assigned unique ID for this managed resource.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object string
    String representing the object's type. Objects of the same type share the same value.
    active bool
    Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
    id str
    The provider-assigned unique ID for this managed resource.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object str
    String representing the object's type. Objects of the same type share the same value.
    active Boolean
    Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object String
    String representing the object's type. Objects of the same type share the same value.

    Look up Existing EntitlementsFeature Resource

    Get an existing EntitlementsFeature 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?: EntitlementsFeatureState, opts?: CustomResourceOptions): EntitlementsFeature
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            active: Optional[bool] = None,
            livemode: Optional[bool] = None,
            lookup_key: Optional[str] = None,
            metadata: Optional[Mapping[str, str]] = None,
            name: Optional[str] = None,
            object: Optional[str] = None) -> EntitlementsFeature
    func GetEntitlementsFeature(ctx *Context, name string, id IDInput, state *EntitlementsFeatureState, opts ...ResourceOption) (*EntitlementsFeature, error)
    public static EntitlementsFeature Get(string name, Input<string> id, EntitlementsFeatureState? state, CustomResourceOptions? opts = null)
    public static EntitlementsFeature get(String name, Output<String> id, EntitlementsFeatureState state, CustomResourceOptions options)
    resources:  _:    type: stripe:EntitlementsFeature    get:      id: ${id}
    import {
      to = stripe_entitlements_feature.example
      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:
    Active bool
    Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    LookupKey string
    A unique key you provide as your own system identifier. This may be up to 80 characters.
    Metadata Dictionary<string, string>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    Name string
    The feature's name, for your own purpose, not meant to be displayable to the customer.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Active bool
    Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    LookupKey string
    A unique key you provide as your own system identifier. This may be up to 80 characters.
    Metadata map[string]string
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    Name string
    The feature's name, for your own purpose, not meant to be displayable to the customer.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    active bool
    Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    lookup_key string
    A unique key you provide as your own system identifier. This may be up to 80 characters.
    metadata map(string)
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    name string
    The feature's name, for your own purpose, not meant to be displayable to the customer.
    object string
    String representing the object's type. Objects of the same type share the same value.
    active Boolean
    Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    lookupKey String
    A unique key you provide as your own system identifier. This may be up to 80 characters.
    metadata Map<String,String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    name String
    The feature's name, for your own purpose, not meant to be displayable to the customer.
    object String
    String representing the object's type. Objects of the same type share the same value.
    active boolean
    Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    lookupKey string
    A unique key you provide as your own system identifier. This may be up to 80 characters.
    metadata {[key: string]: string}
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    name string
    The feature's name, for your own purpose, not meant to be displayable to the customer.
    object string
    String representing the object's type. Objects of the same type share the same value.
    active bool
    Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    lookup_key str
    A unique key you provide as your own system identifier. This may be up to 80 characters.
    metadata Mapping[str, str]
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    name str
    The feature's name, for your own purpose, not meant to be displayable to the customer.
    object str
    String representing the object's type. Objects of the same type share the same value.
    active Boolean
    Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    lookupKey String
    A unique key you provide as your own system identifier. This may be up to 80 characters.
    metadata Map<String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    name String
    The feature's name, for your own purpose, not meant to be displayable to the customer.
    object String
    String representing the object's type. Objects of the same type share the same value.

    Package Details

    Repository
    stripe stripe/terraform-provider-stripe
    License
    Notes
    This Pulumi package is based on the stripe Terraform Provider.
    Viewing docs for Stripe 0.3.0
    published on Friday, Aug 14, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial