TerminalLocationLocation
A Location represents a grouping of readers.
Related guide: Fleet management
Summary
Types
@type address_kana() :: %{ optional(:city) => String.t() | nil, optional(:country) => String.t() | nil, optional(:line1) => String.t() | nil, optional(:line2) => String.t() | nil, optional(:postal_code) => String.t() | nil, optional(:state) => String.t() | nil, optional(:town) => String.t() | nil, optional(String.t()) => term() }
city- City/Ward. Max length: 5000. Nullable.country- Two-letter country code (ISO 3166-1 alpha-2). Max length: 5000. Nullable.line1- Block/Building number. Max length: 5000. Nullable.line2- Building details. Max length: 5000. Nullable.postal_code- ZIP or postal code. Max length: 5000. Nullable.state- Prefecture. Max length: 5000. Nullable.town- Town/cho-me. Max length: 5000. Nullable.
@type address_kanji() :: %{ optional(:city) => String.t() | nil, optional(:country) => String.t() | nil, optional(:line1) => String.t() | nil, optional(:line2) => String.t() | nil, optional(:postal_code) => String.t() | nil, optional(:state) => String.t() | nil, optional(:town) => String.t() | nil, optional(String.t()) => term() }
city- City/Ward. Max length: 5000. Nullable.country- Two-letter country code (ISO 3166-1 alpha-2). Max length: 5000. Nullable.line1- Block/Building number. Max length: 5000. Nullable.line2- Building details. Max length: 5000. Nullable.postal_code- ZIP or postal code. Max length: 5000. Nullable.state- Prefecture. Max length: 5000. Nullable.town- Town/cho-me. Max length: 5000. Nullable.
@type t() :: %Stripe.Resources.Terminal.Location{ address: Stripe.Resources.Address.t(), address_kana: address_kana() | nil, address_kanji: address_kanji() | nil, configuration_overrides: String.t() | nil, display_name: String.t(), display_name_kana: String.t() | nil, display_name_kanji: String.t() | nil, id: String.t(), livemode: boolean(), metadata: %{required(String.t()) => String.t()}, object: String.t(), phone: String.t() | nil }
address- Expandable.address_kana- Expandable.address_kanji- Expandable.configuration_overrides- The ID of a configuration that will be used to customize all readers in this location. Max length: 5000.display_name- The display name of the location. Max length: 5000.display_name_kana- The Kana variation of the display name of the location. Max length: 5000.display_name_kanji- The Kanji variation of the display name of the location. Max length: 5000.id- Unique identifier for the object. Max length: 5000.livemode- Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode.metadata- 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 representing the object's type. Objects of the same type share the same value. Possible values:terminal.location.phone- The phone number of the location. Max length: 5000.