Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Payment Records
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
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

  • configuration_overridesstring

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

Returns

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

POST /v1/terminal/locations/:id
curl https://api.stripe.com/v1/terminal/locations/tml_FBakXQG8bQk4Mm \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -H "Stripe-Version: 2025-03-31.basil" \
  -d 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": {}
}