Terminal Hardware Shipping Method Preview

A TerminalHardwareShipping represents a Shipping Method for Terminal hardware. A Shipping Method is a country-specific representation of a way to ship hardware, containing information such as the country, name, and expected delivery date.

Endpoints

GET/v1/terminal/hardware_shipping_methods/:id

GET/v1/terminal/hardware_shipping_methods

The Terminal Hardware Shipping Method object Preview

Attributes

idstring
Unique identifier for the object.

countryenum
The country in which this Shipping Method is available.
Possible enum values
AD
AE
AF
AG
AI
AL
AM
AO
AQ
AR
Show 239 more

estimated_delivery_windowobject
The estimated delivery period containing the estimated minimum and maximum delivery dates. These dates are not guaranteed.

nameenum
The name of the Terminal Hardware Shipping Method.
Possible enum values
express
Express
priority
Priority
standard
Standard

More attributes

objectstring

providernullable enum

statusenum

unavailable_afternullable integer

The Terminal Hardware Shipping Method object

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

Retrieve a Terminal Hardware Shipping Method Preview

Retrieves a TerminalHardwareShippingMethod object.

Parameters

No parameters.

Returns

Returns a TerminalHardwareShippingMethod object if a valid identifier was provided.

GET /v1/terminal/hardware_shipping_methods/:id

cURL

curl https://api.stripe.com/v1/terminal/hardware_shipping_methods/thsm_MfuTjLaPEgXMa4 \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -H "Stripe-Version: 2025-07-30.basil; terminal_hardware_orders_beta=v5"

Response

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

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-07-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.

Endpoints

POST/v1/terminal/configurations

POST/v1/terminal/configurations/:id

GET/v1/terminal/configurations/:id

GET/v1/terminal/configurations

DELETE/v1/terminal/configurations/:id

Was this page helpful?

Yes No