TerminalLocation

Source: src/Stripe/TerminalLocation.ts

A Stripe Terminal Location — a grouping of Terminal readers at a physical site. Display name, phone, metadata, configuration overrides, and address fields other than country update in place. Changing address.country replaces the location; re-register readers on the new one.

Destroy hard-deletes the location.

Creating a Location

US storefront

const store = yield* Stripe.TerminalLocation("storefront", {
  displayName: "Market Street",
  address: {
    line1: "123 Market Street",
    city: "San Francisco",
    state: "CA",
    postalCode: "94105",
    country: "US",
  },
});

Generated name with phone and metadata

const kiosk = yield* Stripe.TerminalLocation("kiosk", {
  address: {
    line1: "1 Infinite Loop",
    city: "Cupertino",
    state: "CA",
    postalCode: "95014",
    country: "US",
  },
  phone: "+14085551234",
  metadata: { region: "west" },
});

Updating a Location

const store = yield* Stripe.TerminalLocation("storefront", {
  displayName: "Market Street Annex",
  address: {
    line1: "125 Market Street",
    city: "San Francisco",
    state: "CA",
    postalCode: "94105",
    country: "US",
  },
  metadata: { region: "west" },
});

Deleting a Location

// stack.destroy() / resource removal calls DELETE
const store = yield* Stripe.TerminalLocation("storefront", {
  address: {
    line1: "123 Market Street",
    city: "San Francisco",
    state: "CA",
    postalCode: "94105",
    country: "US",
  },
});