1. Registry
  2. Packages
  3. Stripe Provider
  4. API Docs
  5. TerminalLocation
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 Location represents a grouping of readers.

    Related guide: Fleet management

    Create TerminalLocation Resource

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

    Constructor syntax

    new TerminalLocation(name: string, args?: TerminalLocationArgs, opts?: CustomResourceOptions);
    @overload
    def TerminalLocation(resource_name: str,
                         args: Optional[TerminalLocationArgs] = None,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def TerminalLocation(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         address: Optional[TerminalLocationAddressArgs] = None,
                         address_kana: Optional[TerminalLocationAddressKanaArgs] = None,
                         configuration_overrides: Optional[str] = None,
                         display_name: Optional[str] = None,
                         display_name_kana: Optional[str] = None,
                         display_name_kanji: Optional[str] = None,
                         metadata: Optional[Mapping[str, str]] = None,
                         phone: Optional[str] = None)
    func NewTerminalLocation(ctx *Context, name string, args *TerminalLocationArgs, opts ...ResourceOption) (*TerminalLocation, error)
    public TerminalLocation(string name, TerminalLocationArgs? args = null, CustomResourceOptions? opts = null)
    public TerminalLocation(String name, TerminalLocationArgs args)
    public TerminalLocation(String name, TerminalLocationArgs args, CustomResourceOptions options)
    
    type: stripe:TerminalLocation
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "stripe_terminal_location" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args TerminalLocationArgs
    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 TerminalLocationArgs
    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 TerminalLocationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TerminalLocationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TerminalLocationArgs
    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 terminalLocationResource = new Stripe.TerminalLocation("terminalLocationResource", new()
    {
        Address = new Stripe.Inputs.TerminalLocationAddressArgs
        {
            Country = "string",
            City = "string",
            Line1 = "string",
            Line2 = "string",
            PostalCode = "string",
            State = "string",
        },
        AddressKana = new Stripe.Inputs.TerminalLocationAddressKanaArgs
        {
            City = "string",
            Country = "string",
            Line1 = "string",
            Line2 = "string",
            PostalCode = "string",
            State = "string",
            Town = "string",
        },
        ConfigurationOverrides = "string",
        DisplayName = "string",
        DisplayNameKana = "string",
        DisplayNameKanji = "string",
        Metadata = 
        {
            { "string", "string" },
        },
        Phone = "string",
    });
    
    example, err := stripe.NewTerminalLocation(ctx, "terminalLocationResource", &stripe.TerminalLocationArgs{
    	Address: &stripe.TerminalLocationAddressArgs{
    		Country:    pulumi.String("string"),
    		City:       pulumi.String("string"),
    		Line1:      pulumi.String("string"),
    		Line2:      pulumi.String("string"),
    		PostalCode: pulumi.String("string"),
    		State:      pulumi.String("string"),
    	},
    	AddressKana: &stripe.TerminalLocationAddressKanaArgs{
    		City:       pulumi.String("string"),
    		Country:    pulumi.String("string"),
    		Line1:      pulumi.String("string"),
    		Line2:      pulumi.String("string"),
    		PostalCode: pulumi.String("string"),
    		State:      pulumi.String("string"),
    		Town:       pulumi.String("string"),
    	},
    	ConfigurationOverrides: pulumi.String("string"),
    	DisplayName:            pulumi.String("string"),
    	DisplayNameKana:        pulumi.String("string"),
    	DisplayNameKanji:       pulumi.String("string"),
    	Metadata: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Phone: pulumi.String("string"),
    })
    
    resource "stripe_terminal_location" "terminalLocationResource" {
      lifecycle {
        create_before_destroy = true
      }
      address = {
        country     = "string"
        city        = "string"
        line1       = "string"
        line2       = "string"
        postal_code = "string"
        state       = "string"
      }
      address_kana = {
        city        = "string"
        country     = "string"
        line1       = "string"
        line2       = "string"
        postal_code = "string"
        state       = "string"
        town        = "string"
      }
      configuration_overrides = "string"
      display_name            = "string"
      display_name_kana       = "string"
      display_name_kanji      = "string"
      metadata = {
        "string" = "string"
      }
      phone = "string"
    }
    
    var terminalLocationResource = new TerminalLocation("terminalLocationResource", TerminalLocationArgs.builder()
        .address(TerminalLocationAddressArgs.builder()
            .country("string")
            .city("string")
            .line1("string")
            .line2("string")
            .postalCode("string")
            .state("string")
            .build())
        .addressKana(TerminalLocationAddressKanaArgs.builder()
            .city("string")
            .country("string")
            .line1("string")
            .line2("string")
            .postalCode("string")
            .state("string")
            .town("string")
            .build())
        .configurationOverrides("string")
        .displayName("string")
        .displayNameKana("string")
        .displayNameKanji("string")
        .metadata(Map.of("string", "string"))
        .phone("string")
        .build());
    
    terminal_location_resource = stripe.TerminalLocation("terminalLocationResource",
        address={
            "country": "string",
            "city": "string",
            "line1": "string",
            "line2": "string",
            "postal_code": "string",
            "state": "string",
        },
        address_kana={
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "postal_code": "string",
            "state": "string",
            "town": "string",
        },
        configuration_overrides="string",
        display_name="string",
        display_name_kana="string",
        display_name_kanji="string",
        metadata={
            "string": "string",
        },
        phone="string")
    
    const terminalLocationResource = new stripe.TerminalLocation("terminalLocationResource", {
        address: {
            country: "string",
            city: "string",
            line1: "string",
            line2: "string",
            postalCode: "string",
            state: "string",
        },
        addressKana: {
            city: "string",
            country: "string",
            line1: "string",
            line2: "string",
            postalCode: "string",
            state: "string",
            town: "string",
        },
        configurationOverrides: "string",
        displayName: "string",
        displayNameKana: "string",
        displayNameKanji: "string",
        metadata: {
            string: "string",
        },
        phone: "string",
    });
    
    type: stripe:TerminalLocation
    properties:
        address:
            city: string
            country: string
            line1: string
            line2: string
            postalCode: string
            state: string
        addressKana:
            city: string
            country: string
            line1: string
            line2: string
            postalCode: string
            state: string
            town: string
        configurationOverrides: string
        displayName: string
        displayNameKana: string
        displayNameKanji: string
        metadata:
            string: string
        phone: string
    

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

    Address TerminalLocationAddress
    AddressKana TerminalLocationAddressKana
    ConfigurationOverrides string
    The ID of a configuration that will be used to customize all readers in this location.
    DisplayName string
    The display name of the location.
    DisplayNameKana string
    The Kana variation of the display name of the location.
    DisplayNameKanji string
    The Kanji variation of the display name of the location.
    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.
    Phone string
    The phone number of the location.
    Address TerminalLocationAddressArgs
    AddressKana TerminalLocationAddressKanaArgs
    ConfigurationOverrides string
    The ID of a configuration that will be used to customize all readers in this location.
    DisplayName string
    The display name of the location.
    DisplayNameKana string
    The Kana variation of the display name of the location.
    DisplayNameKanji string
    The Kanji variation of the display name of the location.
    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.
    Phone string
    The phone number of the location.
    address object
    address_kana object
    configuration_overrides string
    The ID of a configuration that will be used to customize all readers in this location.
    display_name string
    The display name of the location.
    display_name_kana string
    The Kana variation of the display name of the location.
    display_name_kanji string
    The Kanji variation of the display name of the location.
    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.
    phone string
    The phone number of the location.
    address TerminalLocationAddress
    addressKana TerminalLocationAddressKana
    configurationOverrides String
    The ID of a configuration that will be used to customize all readers in this location.
    displayName String
    The display name of the location.
    displayNameKana String
    The Kana variation of the display name of the location.
    displayNameKanji String
    The Kanji variation of the display name of the location.
    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.
    phone String
    The phone number of the location.
    address TerminalLocationAddress
    addressKana TerminalLocationAddressKana
    configurationOverrides string
    The ID of a configuration that will be used to customize all readers in this location.
    displayName string
    The display name of the location.
    displayNameKana string
    The Kana variation of the display name of the location.
    displayNameKanji string
    The Kanji variation of the display name of the location.
    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.
    phone string
    The phone number of the location.
    address TerminalLocationAddressArgs
    address_kana TerminalLocationAddressKanaArgs
    configuration_overrides str
    The ID of a configuration that will be used to customize all readers in this location.
    display_name str
    The display name of the location.
    display_name_kana str
    The Kana variation of the display name of the location.
    display_name_kanji str
    The Kanji variation of the display name of the location.
    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.
    phone str
    The phone number of the location.
    address Property Map
    addressKana Property Map
    configurationOverrides String
    The ID of a configuration that will be used to customize all readers in this location.
    displayName String
    The display name of the location.
    displayNameKana String
    The Kana variation of the display name of the location.
    displayNameKanji String
    The Kanji variation of the display name of the location.
    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.
    phone String
    The phone number of the location.

    Outputs

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

    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.
    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.
    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.
    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.
    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.
    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.
    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 TerminalLocation Resource

    Get an existing TerminalLocation 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?: TerminalLocationState, opts?: CustomResourceOptions): TerminalLocation
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            address: Optional[TerminalLocationAddressArgs] = None,
            address_kana: Optional[TerminalLocationAddressKanaArgs] = None,
            configuration_overrides: Optional[str] = None,
            display_name: Optional[str] = None,
            display_name_kana: Optional[str] = None,
            display_name_kanji: Optional[str] = None,
            livemode: Optional[bool] = None,
            metadata: Optional[Mapping[str, str]] = None,
            object: Optional[str] = None,
            phone: Optional[str] = None) -> TerminalLocation
    func GetTerminalLocation(ctx *Context, name string, id IDInput, state *TerminalLocationState, opts ...ResourceOption) (*TerminalLocation, error)
    public static TerminalLocation Get(string name, Input<string> id, TerminalLocationState? state, CustomResourceOptions? opts = null)
    public static TerminalLocation get(String name, Output<String> id, TerminalLocationState state, CustomResourceOptions options)
    resources:  _:    type: stripe:TerminalLocation    get:      id: ${id}
    import {
      to = stripe_terminal_location.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:
    Address TerminalLocationAddress
    AddressKana TerminalLocationAddressKana
    ConfigurationOverrides string
    The ID of a configuration that will be used to customize all readers in this location.
    DisplayName string
    The display name of the location.
    DisplayNameKana string
    The Kana variation of the display name of the location.
    DisplayNameKanji string
    The Kanji variation of the display name of the location.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    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.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Phone string
    The phone number of the location.
    Address TerminalLocationAddressArgs
    AddressKana TerminalLocationAddressKanaArgs
    ConfigurationOverrides string
    The ID of a configuration that will be used to customize all readers in this location.
    DisplayName string
    The display name of the location.
    DisplayNameKana string
    The Kana variation of the display name of the location.
    DisplayNameKanji string
    The Kanji variation of the display name of the location.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    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.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Phone string
    The phone number of the location.
    address object
    address_kana object
    configuration_overrides string
    The ID of a configuration that will be used to customize all readers in this location.
    display_name string
    The display name of the location.
    display_name_kana string
    The Kana variation of the display name of the location.
    display_name_kanji string
    The Kanji variation of the display name of the location.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    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.
    object string
    String representing the object's type. Objects of the same type share the same value.
    phone string
    The phone number of the location.
    address TerminalLocationAddress
    addressKana TerminalLocationAddressKana
    configurationOverrides String
    The ID of a configuration that will be used to customize all readers in this location.
    displayName String
    The display name of the location.
    displayNameKana String
    The Kana variation of the display name of the location.
    displayNameKanji String
    The Kanji variation of the display name of the location.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    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.
    object String
    String representing the object's type. Objects of the same type share the same value.
    phone String
    The phone number of the location.
    address TerminalLocationAddress
    addressKana TerminalLocationAddressKana
    configurationOverrides string
    The ID of a configuration that will be used to customize all readers in this location.
    displayName string
    The display name of the location.
    displayNameKana string
    The Kana variation of the display name of the location.
    displayNameKanji string
    The Kanji variation of the display name of the location.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    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.
    object string
    String representing the object's type. Objects of the same type share the same value.
    phone string
    The phone number of the location.
    address TerminalLocationAddressArgs
    address_kana TerminalLocationAddressKanaArgs
    configuration_overrides str
    The ID of a configuration that will be used to customize all readers in this location.
    display_name str
    The display name of the location.
    display_name_kana str
    The Kana variation of the display name of the location.
    display_name_kanji str
    The Kanji variation of the display name of the location.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    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.
    object str
    String representing the object's type. Objects of the same type share the same value.
    phone str
    The phone number of the location.
    address Property Map
    addressKana Property Map
    configurationOverrides String
    The ID of a configuration that will be used to customize all readers in this location.
    displayName String
    The display name of the location.
    displayNameKana String
    The Kana variation of the display name of the location.
    displayNameKanji String
    The Kanji variation of the display name of the location.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    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.
    object String
    String representing the object's type. Objects of the same type share the same value.
    phone String
    The phone number of the location.

    Supporting Types

    TerminalLocationAddress, TerminalLocationAddressArgs

    Country string
    Two-letter country code (ISO 3166-1 alpha-2).
    City string
    City, district, suburb, town, or village.
    Line1 string
    Address line 1, such as the street, PO Box, or company name.
    Line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    PostalCode string
    ZIP or postal code.
    State string
    State, county, province, or region (ISO 3166-2).
    Country string
    Two-letter country code (ISO 3166-1 alpha-2).
    City string
    City, district, suburb, town, or village.
    Line1 string
    Address line 1, such as the street, PO Box, or company name.
    Line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    PostalCode string
    ZIP or postal code.
    State string
    State, county, province, or region (ISO 3166-2).
    country string
    Two-letter country code (ISO 3166-1 alpha-2).
    city string
    City, district, suburb, town, or village.
    line1 string
    Address line 1, such as the street, PO Box, or company name.
    line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    postal_code string
    ZIP or postal code.
    state string
    State, county, province, or region (ISO 3166-2).
    country String
    Two-letter country code (ISO 3166-1 alpha-2).
    city String
    City, district, suburb, town, or village.
    line1 String
    Address line 1, such as the street, PO Box, or company name.
    line2 String
    Address line 2, such as the apartment, suite, unit, or building.
    postalCode String
    ZIP or postal code.
    state String
    State, county, province, or region (ISO 3166-2).
    country string
    Two-letter country code (ISO 3166-1 alpha-2).
    city string
    City, district, suburb, town, or village.
    line1 string
    Address line 1, such as the street, PO Box, or company name.
    line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    postalCode string
    ZIP or postal code.
    state string
    State, county, province, or region (ISO 3166-2).
    country str
    Two-letter country code (ISO 3166-1 alpha-2).
    city str
    City, district, suburb, town, or village.
    line1 str
    Address line 1, such as the street, PO Box, or company name.
    line2 str
    Address line 2, such as the apartment, suite, unit, or building.
    postal_code str
    ZIP or postal code.
    state str
    State, county, province, or region (ISO 3166-2).
    country String
    Two-letter country code (ISO 3166-1 alpha-2).
    city String
    City, district, suburb, town, or village.
    line1 String
    Address line 1, such as the street, PO Box, or company name.
    line2 String
    Address line 2, such as the apartment, suite, unit, or building.
    postalCode String
    ZIP or postal code.
    state String
    State, county, province, or region (ISO 3166-2).

    TerminalLocationAddressKana, TerminalLocationAddressKanaArgs

    City string
    City/Ward.
    Country string
    Two-letter country code (ISO 3166-1 alpha-2).
    Line1 string
    Block/Building number.
    Line2 string
    Building details.
    PostalCode string
    ZIP or postal code.
    State string
    Prefecture.
    Town string
    Town/cho-me.
    City string
    City/Ward.
    Country string
    Two-letter country code (ISO 3166-1 alpha-2).
    Line1 string
    Block/Building number.
    Line2 string
    Building details.
    PostalCode string
    ZIP or postal code.
    State string
    Prefecture.
    Town string
    Town/cho-me.
    city string
    City/Ward.
    country string
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 string
    Block/Building number.
    line2 string
    Building details.
    postal_code string
    ZIP or postal code.
    state string
    Prefecture.
    town string
    Town/cho-me.
    city String
    City/Ward.
    country String
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 String
    Block/Building number.
    line2 String
    Building details.
    postalCode String
    ZIP or postal code.
    state String
    Prefecture.
    town String
    Town/cho-me.
    city string
    City/Ward.
    country string
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 string
    Block/Building number.
    line2 string
    Building details.
    postalCode string
    ZIP or postal code.
    state string
    Prefecture.
    town string
    Town/cho-me.
    city str
    City/Ward.
    country str
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 str
    Block/Building number.
    line2 str
    Building details.
    postal_code str
    ZIP or postal code.
    state str
    Prefecture.
    town str
    Town/cho-me.
    city String
    City/Ward.
    country String
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 String
    Block/Building number.
    line2 String
    Building details.
    postalCode String
    ZIP or postal code.
    state String
    Prefecture.
    town String
    Town/cho-me.

    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