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

The TerminalHardwareProduct object Preview

Attributes

  • idstring

    Unique identifier for the object.

  • objectstring

    String representing the object’s type. Objects of the same type share the same value.

  • statusenum

    The status of the terminal hardware product.

    Possible enum values
    available

    Available for new orders.

    unavailable

    Can no longer be used for order creation.

  • typestring

    The type of product.

  • unavailable_afternullable integer

    If all the SKUs for this product have an unavailable_after then this is the max unavailable_after in UNIX timestamp. Otherwise, null.

The TerminalHardwareProduct object
{
  "id": "thpr_MJfotcxYT5Hwsm",
  "object": "terminal.hardware_product",
  "status": "available",
  "type": "bbpos_wisepos_e",
  "unavailable_after": null
}

Retrieve a Terminal Hardware Product Preview

Retrieves a TerminalHardwareProduct object.

Parameters

No parameters.

Returns

Returns a TerminalHardwareProduct object if a valid identifier was provided.

GET /v1/terminal/hardware_products/:id
curl https://api.stripe.com/v1/terminal/hardware_products/thpr_MJfotcxYT5Hwsm \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -H "Stripe-Version: 2025-08-27.basil; terminal_hardware_orders_beta=v5"
Response
{
  "id": "thpr_MJfotcxYT5Hwsm",
  "object": "terminal.hardware_product",
  "status": "available",
  "type": "bbpos_wisepos_e",
  "unavailable_after": null
}

List all Terminal Hardware Products Preview

List all TerminalHardwareProduct objects.

Parameters

  • statusenum

    Only return products 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

  • starting_afterstring

Returns

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

GET /v1/terminal/hardware_products
curl https://api.stripe.com/v1/terminal/hardware_products \
  -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_products",
  "has_more": false,
  "data": [
    {
      "id": "thpr_MJfotcxYT5Hwsm",
      "object": "terminal.hardware_product",
      "status": "available",
      "type": "bbpos_wisepos_e",
      "unavailable_after": null
    }
  ]
}

Terminal Hardware SKU Preview

A TerminalHardwareSKU represents a SKU for Terminal hardware. A SKU is a representation of a product available for purchase, containing information such as the name, price, and images.

Endpoints

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