Sample - Stripe API
POST/v1/terminal/locations

Create a Location

Creates a new Location object. For further details, including which address fields are required in each country, see the Manage locations guide.

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

10 body fields
addressobjectoptional
The full address of the 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. Maximum length is 1000 characters.
display_name_kanastringoptional
The Kana variation of the name for the location (Japan only). Maximum length is 1000 characters.
display_name_kanjistringoptional
The Kanji variation of the name for the location (Japan only). Maximum length is 1000 characters.
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
200Successful response.
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

Any other status is an error: Error response.