List all Terminal Hardware Shipping Methods Preview

List all TerminalHardwareShippingMethod objects.

Parameters

  • countrystringRequired

    Only return Shipping Methods that have the given country. If provided, country must be a two-letter country code (ISO 3166-1 alpha-2).

  • nameenum

    Only return Shipping Methods that have the given name.

    Possible enum values
    express

    Express

    priority

    Priority

    standard

    Standard

  • statusenum

    Only return Shipping Methods that have the given status. Defaults to Available.

    Possible enum values
    available

    Available for new orders.

    unavailable

    Can no longer be used for order creation.

More parameters

  • ending_beforestring

  • limitinteger

  • providerenum

  • starting_afterstring

Returns

A dictionary with a data property that contains an array of terminal hardware shipping methods. Each entry in the array is a separate ShippingMethod object.

GET /v1/terminal/hardware_shipping_methods
cURL
curl https://api.stripe.com/v1/terminal/hardware_shipping_methods \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
-H "Stripe-Version: 2025-06-30.basil; terminal_hardware_orders_beta=v5"
Response
{
"object": "list",
"url": "/v1/terminal/hardware_shipping_methods",
"has_more": false,
"data": [
{
"id": "thsm_MfuTjLaPEgXMa4",
"object": "terminal.hardware_shipping_method",
"country": "US",
"estimated_delivery_window": {
"maximum_date": "2023-10-03",
"minimum_date": "2023-10-03"
},
"name": "standard",
"status": "available",
"unavailable_after": null
}
]
}

Configuration 

A Configurations object represents how features should be configured for terminal readers. For information about how to use it, see the Terminal configurations documentation.

Financial Accounts 

Stripe Treasury provides users with a container for money called a FinancialAccount that is separate from their Payments balance. FinancialAccounts serve as the source and destination of Treasury’s money movement APIs.

Financial Account Features 

Encodes whether a FinancialAccount has access to a particular Feature, with a status enum and associated status_details. Stripe or the platform can control Features via the requested field.

Transactions 

Transactions represent changes to a FinancialAccount’s balance.