Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Update a Location 

Terminal
Location
Update a Location

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Parameters

  • addressobject

    The full address of the location. You can’t change the location’s country. If you need to modify the country field, create a new Location object and re-register any existing readers to that location.

    • address.citystring

      City, district, suburb, town, or village.

    • address.countrystringRequired for calculating taxes

      Two-letter country code (ISO 3166-1 alpha-2).

    • address.line1string

      Address line 1 (e.g., street, PO Box, or company name).

    • address.line2string

      Address line 2 (e.g., apartment, suite, unit, or building).

    • address.postal_codestringRequired for calculating taxes

      ZIP or postal code.

    • address.statestring

      State, county, province, or region.

  • display_namestring

    A name for the location.

  • metadataobject

    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

More parameters

  • address_kanaobjectPreview feature

    The Kana variation of the full address of the location (Japan only).

    • address_kana.citystring

      City or ward.

    • address_kana.countrystring

      Two-letter country code (ISO 3166-1 alpha-2).

    • address_kana.line1string

      Block or building number.

    • address_kana.line2string

      Building details.

    • address_kana.postal_codestring

      Postal code.

    • address_kana.statestring

      Prefecture.

    • address_kana.townstring

      Town or cho-me.

  • address_kanjiobjectPreview feature

    The Kanji variation of the full address of the location (Japan only).

    • address_kanji.citystring

      City or ward.

    • address_kanji.countrystring

      Two-letter country code (ISO 3166-1 alpha-2).

    • address_kanji.line1string

      Block or building number.

    • address_kanji.line2string

      Building details.

    • address_kanji.postal_codestring

      Postal code.

    • address_kanji.statestring

      Prefecture.

    • address_kanji.townstring

      Town or cho-me.

  • configuration_overridesstring

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

  • display_name_kanastringPreview feature

    The Kana variation of the name for the location (Japan only).

  • display_name_kanjistringPreview feature

    The Kanji variation of the name for the location (Japan only).

  • phonestringPreview feature

    The phone number for the location.

Returns

Returns an updated Location object if a valid identifier was provided.

POST /v1/terminal/locations/:id
const stripe = require('stripe')('sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2');
const location = await stripe.terminal.locations.update(
  'tml_FBakXQG8bQk4Mm',
  {
    display_name: 'Update Store Name',
  }
);
Response
{
  "id": "tml_FBakXQG8bQk4Mm",
  "object": "terminal.location",
  "address": {
    "city": "San Francisco",
    "country": "US",
    "line1": "1234 Main Street",
    "line2": "",
    "postal_code": "94111",
    "state": "CA"
  },
  "display_name": "Update Store Name",
  "livemode": false,
  "metadata": {}
}