TerminalConfiguration

Source: src/Stripe/TerminalConfiguration.ts

A Stripe Terminal Configuration — splash screens, tipping, offline mode, reboot window, cellular, and Wi-Fi for smart readers. Name and nested settings update in place. Destroy hard-deletes the configuration. The account default configuration is never adopted or listed.

Terminal configurations have no metadata field. Identity is the Stripe id plus the unique name. Account-wide list() (nuke) enumerates every non-default configuration on the account.

Creating a Configuration

Named configuration with USD tipping

const config = yield* Stripe.TerminalConfiguration("storefront", {
  name: "Storefront",
  offline: { enabled: true },
  tipping: {
    usd: {
      fixedAmounts: [100, 200, 300],
      percentages: [15, 20, 25],
      smartTipThreshold: 1000,
    },
  },
});

Reboot window

const config = yield* Stripe.TerminalConfiguration("storefront", {
  name: "Storefront",
  rebootWindow: { startHour: 2, endHour: 4 },
});

Updating a Configuration

const config = yield* Stripe.TerminalConfiguration("storefront", {
  name: "Storefront (updated)",
  offline: { enabled: false },
  tipping: {
    usd: {
      fixedAmounts: [200, 300, 400],
      percentages: [10, 15, 20],
      smartTipThreshold: 2000,
    },
  },
});

Deleting a Configuration

// stack.destroy() / resource removal hard-deletes the configuration
const config = yield* Stripe.TerminalConfiguration("storefront", {
  name: "Storefront",
});