Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

List all Terminal Hardware Shipping Methods Preview

Terminal
Terminal Hardware Shipping Method
List all Terminal Hardware Shipping Methods

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

    A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

  • limitinteger

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

  • providerenum

    The provider associated with this ShippingMethod.

    Possible enum values
    stripe

    The Stripe provider

  • starting_afterstring

    A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

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 https://api.stripe.com/v1/terminal/hardware_shipping_methods \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -H "Stripe-Version: 2025-08-27.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
    }
  ]
}