Sample - Stripe API
POST/v1/terminal/locations/{location}

Update a Terminal location

Updates a Terminal location without changing fields that you omit from the request. Use address, display_name, and the other supported fields to modify location details, but create a new location if you need to change its country.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 10 body fields
locationstringrequired
The unique identifier of the location to update. Must be no longer than 5000 characters.

Fields to update on the Terminal location; omitted fields remain unchanged.

addressobjectoptional
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_kanaobjectoptional
The Kana variation of the full address of the location (Japan only).
address_kanjiobjectoptional
The Kanji variation of the full address of the location (Japan only).
configuration_overridesstringoptional
The ID of a configuration that will be used to customize all readers in this location.
display_namestringoptional
A name for the location.
display_name_kanastringoptional
The Kana variation of the name for the location (Japan only).
display_name_kanjistringoptional
The Kanji variation of the name for the location (Japan only).
expandarray<string>optional
Specifies which fields in the response should be expanded.
metadataobjectoptional
Set of [key-value pairs](https://docs.stripe.com/api/metadata) 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`.
phonestringoptional
The phone number for the location.

2 status codes
200Returns the updated location object, or a deleted-location representation when the location has been deleted.
addressobjectrequired
address_kanaobjectoptional
address_kanjiobjectoptional
configuration_overridesstringoptional
The ID of a configuration that will be used to customize all readers in this location.
display_namestringrequired
The display name of the location.
display_name_kanastringoptional
The Kana variation of the display name of the location.
display_name_kanjistringoptional
The Kanji variation of the display name of the location.
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectrequired
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:terminal.location
phonestringoptional
The phone number of the location.
defaultError response.
errorobjectrequired

Error handling

location must be a string no longer than 5000 characters. address, address_kana, and address_kanji support the defined address fields, while configuration_overrides, display_name, display_name_kana, and display_name_kanji must be strings of up to 1000 characters or an empty string. metadata values must be strings, and country cannot be changed through this operation.