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 TerminalHardwareOrder object Preview

Terminal
Terminal Hardware Order
The TerminalHardwareOrder object

Attributes

  • idstring

    Unique identifier for the object.

  • amountinteger

    A positive integer in the smallest currency unit. Represents the total cost for the order.

  • currencyenum

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

  • hardware_order_itemsarray of objects

    An array of line items ordered.

    • hardware_order_items.amountinteger

      A positive integer that represents the cost of the order in the smallest currency unit.

    • hardware_order_items.currencyenum

      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • hardware_order_items.quantityinteger

      The quantity to be ordered.

    • hardware_order_items.terminal_hardware_skuobject

      The TerminalHardwareSKU.

      • hardware_order_items.terminal_hardware_sku.idstring

        Unique identifier for the object.

      • hardware_order_items.terminal_hardware_sku.amountinteger

        The price of this SKU.

      • hardware_order_items.terminal_hardware_sku.countryenum

        The country in which this SKU is available.

        Possible enum values
        AD
        AE
        AF
        AG
        AI
        AL
        AM
        AO
        AQ
        AR
        Show 239 more

      • hardware_order_items.terminal_hardware_sku.currencyenum

        Three-letter ISO currency code, in lowercase. Must be a supported currency.

        Possible enum values
        aed
        afn
        all
        amd
        ang
        aoa
        ars
        aud
        awg
        azn
        Show 141 more

      • hardware_order_items.terminal_hardware_sku.productstringExpandable

        ID of the product for this SKU.

  • metadatanullable object

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

  • payment_typeenum

    The method of payment for this order.

    Possible enum values
    monthly_invoice

    A consolidated invoice issued by Stripe at the end of each month.

    none

    No charges apply.

    payment_intent

    A one-time payment processed at the time of order creation in the dashboard.

  • shippingobject

    Shipping address for the order.

    • shipping.addressobject

      Shipping address.

      • shipping.address.citynullable string

        City, district, suburb, town, or village.

      • shipping.address.countrynullable string

        Two-letter country code (ISO 3166-1 alpha-2).

      • shipping.address.line1nullable string

        Address line 1 (e.g., street, or company name).

      • shipping.address.line2nullable string

        Address line 2 (e.g., apartment, suite, unit, or building).

      • shipping.address.postal_codenullable string

        ZIP or postal code.

      • shipping.address.statenullable string

        State, county, province, or region.

    • shipping.amountinteger

      A positive integer in the smallest currency unit. Represents the cost for shippingthe order.

    • shipping.companynullable string

      Company name.

    • shipping.currencyenum

      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • shipping.emailstring

      Customer email. This email will receive Stripe-branded update emails when the status of the order changes.

    • shipping.namestring

      Customer name.

    • shipping.phonestring

      Customer phone (including extension).

  • shipping_methodstring

    The Shipping Method for the order.

  • statusenum

    The status of the terminal hardware order.

    Possible enum values
    canceled

    Order was canceled. Please create a new order to receive these items.

    delivered

    Order has been delivered!

    pending

    Order has been received and can still be canceled.

    ready_to_ship

    Order has been confirmed and is pending shipment. It cannot be canceled.

    shipped

    Order has been shipped, and can no longer be canceled.

    undeliverable

    One or more of the order’s items could not be delivered.

More attributes

  • objectstring

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

  • createdtimestamp

    Time at which the object was created. Measured in seconds since the Unix epoch.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • po_numbernullable string

    The purchase order number will appear on the packing slip, shipping label, and monthly billing invoice.

  • shipment_trackingarray of objects

    Returns the tracking information for each shipment.

    • shipment_tracking.carrierenum

      The name of the carrier delivering the order.

      Possible enum values
      abf_freight

      ABF Freight

      australia_post

      Australia Post

      canada_post

      Canada Post

      dhl

      DHL

      dpd

      DPD

      estes_express

      Estes Express

      fedex

      FedEx

      fedex_freight

      Fedex Freight

      other

      A placeholder to catch new carriers in your integration as we introduce them.

      palletforce

      Palletforce

      Show 7 more

    • shipment_tracking.tracking_numberstring

      The number used to identify the shipment with the carrier responsible for delivery.

  • taxinteger

    The amount of tax on this order, summed from all the tax amounts.

  • total_tax_amountsarray of objects

    The aggregate amounts calculated per tax rate for all of the items on the order.

    • total_tax_amounts.amountinteger

      A positive integer that represents the cost of tax in the smallest currency unit.

    • total_tax_amounts.inclusiveboolean

      Whether the tax rate is inclusive or exclusive

    • total_tax_amounts.rateobject

      The tax rate that applies to this order.

      • total_tax_amounts.rate.display_namestring

        The display name of the tax rate.

      • total_tax_amounts.rate.jurisdictionnullable string

        Tax jurisdiction.

      • total_tax_amounts.rate.percentagefloat

        The percentage associated with the tax rate.

  • updatednullable timestamp

    Time at which the object was last updated. Measured in seconds since the Unix epoch.

The TerminalHardwareOrder object
{
  "id": "thor_1Nj6mu2eZvKYlo2CRG74vB9n",
  "object": "terminal.hardware_order",
  "amount": 13602,
  "created": 1692995962,
  "currency": "usd",
  "hardware_order_items": [
    {
      "amount": 11800,
      "currency": "usd",
      "quantity": 2,
      "terminal_hardware_sku": {
        "id": "thsku_OEu70OWVaQ0DG3",
        "amount": 450,
        "country": "US",
        "currency": "usd",
        "product": "thpr_NGubNsbUoS1oik"
      }
    }
  ],
  "livemode": true,
  "metadata": {},
  "payment_type": "monthly_invoice",
  "po_number": null,
  "shipment_tracking": [],
  "shipping": {
    "address": {
      "city": "San Francisco",
      "country": "US",
      "line1": "1234 Main Street",
      "line2": "",
      "postal_code": "94111",
      "state": "CA"
    },
    "amount": 800,
    "company": "Rocket Rides",
    "currency": "usd",
    "email": "test@example.com",
    "name": "Jenny Rosen",
    "phone": "15555555555"
  },
  "shipping_method": "standard",
  "status": "pending",
  "tax": 1002,
  "total_tax_amounts": [
    {
      "amount": 1002,
      "inclusive": false,
      "rate": {
        "display_name": "Sales Tax",
        "jurisdiction": "LOS ANGELES",
        "percentage": 8.25
      }
    }
  ],
  "updated": null
}