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

Location 

A Location represents a grouping of readers.

Related guide: Fleet management

Endpoints

The Location object 

Attributes

  • idstring

    Unique identifier for the object.

  • addressobject

    The full address of the location.

  • display_namestring

    The display name of 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.

More attributes

  • objectstring

  • configuration_overridesnullable string

  • livemodeboolean

The Location object
{
  "id": "tml_FBakXQG8bQk4Mm",
  "object": "terminal.location",
  "address": {
    "city": "San Francisco",
    "country": "US",
    "line1": "1234 Main Street",
    "line2": "",
    "postal_code": "94111",
    "state": "CA"
  },
  "display_name": "My First Store",
  "livemode": false,
  "metadata": {}
}

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.

Parameters

  • addressobjectRequired

    The full address of the location.

  • display_namestringRequired

    A name for the location. Maximum length is 1000 characters.

  • 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

Returns

Returns a Location object if creation succeeds.

POST /v1/terminal/locations
const stripe = require('stripe')('sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2');
const location = await stripe.terminal.locations.create({
  display_name: 'My First Store',
  address: {
    line1: '1234 Main Street',
    city: 'San Francisco',
    postal_code: '94111',
    state: 'CA',
    country: 'US',
  },
});
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": "My First Store",
  "livemode": false,
  "metadata": {}
}

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.

  • 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

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": {}
}

Retrieve a Location 

Retrieves a Location object.

Parameters

No parameters.

Returns

Returns a Location object if a valid identifier was provided.

GET /v1/terminal/locations/:id
const stripe = require('stripe')('sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2');
const location = await stripe.terminal.locations.retrieve('tml_FBakXQG8bQk4Mm');
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": "My First Store",
  "livemode": false,
  "metadata": {}
}