Mayson Monorepo Documentation
    Preparing search index...

    Interface Location

    A Location represents a grouping of readers.

    Related guide: Fleet management

    interface Location {
        id: string;
        object: "terminal.location";
        address: Stripe.Address;
        address_kana?: Stripe.Terminal.Location.AddressKana;
        address_kanji?: Stripe.Terminal.Location.AddressKanji;
        configuration_overrides?: string;
        deleted?: void;
        display_name: string;
        display_name_kana?: string;
        display_name_kanji?: string;
        livemode: boolean;
        metadata: Metadata;
        phone?: string;
    }
    Index

    Properties

    id object address address_kana? address_kanji? configuration_overrides? deleted? display_name display_name_kana? display_name_kanji? livemode metadata phone?

    Properties

    id: string

    Unique identifier for the object.

    object: "terminal.location"

    String representing the object's type. Objects of the same type share the same value.

    address: Stripe.Address
    address_kana?: Stripe.Terminal.Location.AddressKana
    address_kanji?: Stripe.Terminal.Location.AddressKanji
    configuration_overrides?: string

    The ID of a configuration that will be used to customize all readers in this location.

    deleted?: void

    Always true for a deleted object

    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: boolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    metadata: 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.

    phone?: string

    The phone number of the location.

    Settings

    Member Visibility

    On This Page

    Properties