Stripe: Retrieve a Configuration

← Terminal operations · Get started

Operation stripe.getterminalconfigurationsconfiguration

Provider route: GET /v1/terminal/configurations/{configuration}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["terminal"]["getTerminalConfigurationsConfiguration"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.terminal.getTerminalConfigurationsConfiguration(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.terminal.get_terminal_configurations_configuration(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.configuration	string	Required within parent	Maximum length: 5000
query	object	Optional	Additional keys: not allowed
query.expand	array	Optional
query.expand[]	string	Each item	Maximum length: 5000

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Create a Configuration — response body
$ (anyOf 2)	Model	Alternative	Expand Delete a Configuration — response body

Referenced models: Delete a Configuration — response body, Create a Configuration — response body

Schemas

6 more schemas are linked from the tables above, on the schema pages.

Delete a Configuration — response body

Field	Type	Presence	Description and constraints
$	object	Root
deleted	boolean	Required within parent	Always true for a deleted object Known values: True
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: terminal.configuration

Create a Configuration — response body

Field	Type	Presence	Description and constraints
$	object	Root	A Configurations object represents how features should be configured for terminal readers. For information about how to use it, see the [Terminal configurations documentation](https://docs.stripe.com/terminal/fleet/configurations-overview).
bbpos_wisepad3	Model	Optional	Expand Create a Configuration — response body — stripe s700
bbpos_wisepos_e	Model	Optional	Expand Create a Configuration — response body — stripe s700
cellular	Model	Optional	Expand Create a Configuration — response body — cellular
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
is_account_default	JSON	Optional
is_account_default (anyOf 1)	boolean	Alternative	Whether this Configuration is the default for your account
is_account_default (anyOf 2)	null	Alternative
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
name	JSON	Optional
name (anyOf 1)	string	Alternative	String indicating the name of the Configuration object, set by the user Maximum length: 5000
name (anyOf 2)	null	Alternative
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: terminal.configuration
offline	Model	Optional	Expand Create a Configuration — response body — offline
reboot_window	Model	Optional	Expand Create a Configuration — response body — reboot window
stripe_s700	Model	Optional	Expand Create a Configuration — response body — stripe s700
stripe_s710	Model	Optional	Expand Create a Configuration — response body — stripe s700
tipping	Model	Optional	Expand Create a Configuration — response body — tipping
verifone_m425	Model	Optional	Expand Create a Configuration — response body — stripe s700
verifone_p400	Model	Optional	Expand Create a Configuration — response body — stripe s700
verifone_p630	Model	Optional	Expand Create a Configuration — response body — stripe s700
verifone_ux700	Model	Optional	Expand Create a Configuration — response body — stripe s700
verifone_v660p	Model	Optional	Expand Create a Configuration — response body — stripe s700
wifi	Model	Optional	Expand Create a Configuration — response body — wifi

Referenced models: Create a Configuration — response body — cellular, Create a Configuration — response body — stripe s700, Create a Configuration — response body — offline, Create a Configuration — response body — reboot window, Create a Configuration — response body — tipping, Create a Configuration — response body — wifi

Create a Configuration — response body — cellular

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Whether a cellular-capable reader can connect to the internet over cellular.

Create a Configuration — response body — stripe s700

Field	Type	Presence	Description and constraints
$	object	Root
splashscreen	JSON	Optional	A File ID representing an image to display on the reader
splashscreen (anyOf 1)	string	Alternative	Maximum length: 5000
splashscreen (anyOf 2)	Model	Alternative	Expand Create a file — response body

Referenced models: Create a file — response body

Create a Configuration — response body — offline

Field	Type	Presence	Description and constraints
$	object	Root
enabled	JSON	Optional
enabled (anyOf 1)	boolean	Alternative	Determines whether to allow transactions to be collected while reader is offline. Defaults to false.
enabled (anyOf 2)	null	Alternative

Create a Configuration — response body — reboot window

Field	Type	Presence	Description and constraints
$	object	Root
end_hour	JSON	Required within parent
end_hour (anyOf 1)	integer	Alternative	Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.
end_hour (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
start_hour	JSON	Required within parent
start_hour (anyOf 1)	integer	Alternative	Integer between 0 to 23 that represents the start hour of the reboot time window.
start_hour (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create a Configuration — response body — wifi

Field	Type	Presence	Description and constraints
$	object	Root
enterprise_eap_peap	Model	Optional	Expand Create a Configuration — response body — wifi enterprise eap peap
enterprise_eap_tls	Model	Optional	Expand Create a Configuration — response body — wifi enterprise eap tls
personal_psk	Model	Optional	Expand Create a Configuration — response body — wifi personal psk
type	string	Required within parent	Security type of the WiFi network. The hash with the corresponding name contains the credentials for this security type. Known values: enterprise_eap_peap, enterprise_eap_tls, personal_psk

Referenced models: Create a Configuration — response body — wifi enterprise eap peap, Create a Configuration — response body — wifi enterprise eap tls, Create a Configuration — response body — wifi personal psk

Create a Configuration — response body — tipping aed

Field	Type	Presence	Description and constraints
$	object	Root
fixed_amounts	JSON	Optional
fixed_amounts (anyOf 1)	array	Alternative	Fixed amounts displayed when collecting a tip
fixed_amounts (anyOf 1)[]	JSON	Each item
fixed_amounts (anyOf 1)[] (anyOf 1)	integer	Alternative
fixed_amounts (anyOf 1)[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fixed_amounts (anyOf 2)	null	Alternative
percentages	JSON	Optional
percentages (anyOf 1)	array	Alternative	Percentages displayed when collecting a tip
percentages (anyOf 1)[]	JSON	Each item
percentages (anyOf 1)[] (anyOf 1)	integer	Alternative
percentages (anyOf 1)[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
percentages (anyOf 2)	null	Alternative
smart_tip_threshold	JSON	Optional
smart_tip_threshold (anyOf 1)	integer	Alternative	Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
smart_tip_threshold (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: stripe.getterminalconfigurationsconfiguration. Catalog operation: GetTerminalConfigurationsConfiguration. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source