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

Retrieve a Terminal location

Retrieves a Terminal location by its location ID. Use expand to include additional response fields when retrieving the location. The response can contain either the location object or a deleted location object.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
locationstringrequired
The unique identifier of the Terminal location to retrieve. Must not exceed 5000 characters.
expandarray<string>optional
Fields to expand in the response. Each value must not exceed 5000 characters.

2 status codes
200Returns the requested Terminal location object, or a deleted location object containing its identifier and deleted state.
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.
defaultReturns an error object containing an error type and, when available, details such as a message, parameter, code, or documentation URL.
errorobjectrequired

Error handling

location must identify the location to retrieve and must not exceed 5000 characters. Each expand value must not exceed 5000 characters when provided.