The TerminalHardwareOrder object ​
Attributes ​
id(string) Unique identifier for the object.object(string) String representing the object’s type. Objects of the same type share the same value.amount(integer) A positive integer in the smallest currency unit. Represents the total cost for the order.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.hardware_order_items(array of objects) An array of line items ordered.hardware_order_items.amount(integer) A positive integer that represents the cost of the order in the smallest currency unit.hardware_order_items.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.hardware_order_items.quantity(integer) The quantity to be ordered.hardware_order_items.terminal_hardware_sku(object) TheTerminalHardwareSKU.hardware_order_items.terminal_hardware_sku.id(string) Unique identifier for the object.hardware_order_items.terminal_hardware_sku.amount(integer) The price of the SKU.hardware_order_items.terminal_hardware_sku.country(enum) The country in which this SKU is available. Possible enum values:ADAEAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZW
hardware_order_items.terminal_hardware_sku.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency. Possible enum values:aedafnallamdangaoaarsaudawgaznbambbdbdtbgnbhdbifbmdbndbobbrlbsdbtnbwpbynbzdcadcdfchfclpcnycopcrccveczkdjfdkkdopdzdeekegpetbeurfjdfkpgbpgelghsgipgmdgnfgtqgydhkdhnlhrkhtghufidrilsinriskjmdjodjpykeskgskhrkmfkrwkwdkydkztlaklbplkrlrdlslltllvlmadmdlmgamkdmmkmntmopmromurmvrmwkmxnmyrmznnadngnnionoknprnzdomrpabpenpgkphppkrplnpygqarronrsdrubrwfsarsbdscrseksgdshpslesllsossrdstdsvcszlthbtjstndtoptryttdtwdtzsuahugxusdusdcuyuuzsvefvndvuvwstxafxcdxcgxofxpfyerzarzmw
hardware_order_items.terminal_hardware_sku.product(string, expandable (can be expanded into an object with theexpandrequest parameter)) ID of the product for this SKU.
livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.metadata(object, nullable) 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_type(enum) The method of payment for this order. Possible enum values:monthly_invoiceA consolidated invoice issued by Stripe at the end of each month.noneNo charges apply.payment_intentA one-time payment processed at the time of order creation in the dashboard.
po_number(string, nullable) The purchase order number will appear on the packing slip, shipping label, and monthly billing invoice.shipment_tracking(array of objects) Returns the tracking information for each shipment.shipment_tracking.carrier(enum) The name of the carrier delivering the order. Possible enum values:abf_freightABF Freightaustralia_postAustralia Postcanada_postCanada PostdhlDHLdpdDPDestes_expressEstes Expressexact_logisticsExact Logistics / PallexfedexFedExfedex_freightFedex FreightotherA placeholder to catch new carriers in your integration as we introduce them.palletforcePalletforcepurolatorPurolatorroyal_mailRoyal Mailtforce_freightTForce Freighttnt_australiaTNT AustraliaupsUPSups_freightUPS FreightuspsUSPS
shipment_tracking.tracking_number(string) The number used to identify the shipment with the carrier responsible for delivery.
shipping(object) Shipping address for the order.shipping.address(object) Shipping address.shipping.address.city(string, nullable) City, district, suburb, town, or village.shipping.address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).shipping.address.line1(string, nullable) Address line 1 (e.g., street, or company name).shipping.address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.shipping.address.postal_code(string, nullable) ZIP or postal code.shipping.address.state(string, nullable) State, county, province, or region (ISO 3166-2).
shipping.amount(integer) A positive integer in the smallest currency unit. Represents the cost for shippingthe order.shipping.company(string, nullable) Company name.shipping.currency(enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.shipping.email(string) Customer email. This email will receive Stripe-branded update emails when the status of the order changes.shipping.name(string) Customer name.shipping.phone(string) Customer phone (including extension).
shipping_method(string) The Shipping Method for the order.status(enum) The status of the terminal hardware order. Possible enum values:canceledOrder was canceled. Please create a new order to receive these items.deliveredOrder has been delivered!pendingOrder has been received and can still be canceled.ready_to_shipOrder has been confirmed and is pending shipment. It cannot be canceled.shippedOrder has been shipped, and can no longer be canceled.undeliverableOne or more of the order’s items could not be delivered.
tax(integer) The amount of tax on this order, summed from all the tax amounts.total_tax_amounts(array of objects) The aggregate amounts calculated per tax rate for all of the items on the order.total_tax_amounts.amount(integer) A positive integer that represents the cost of tax in the smallest currency unit.total_tax_amounts.inclusive(boolean) Whether the tax rate is inclusive or exclusivetotal_tax_amounts.rate(object) The tax rate that applies to this order.total_tax_amounts.rate.display_name(string) The display name of the tax rate.total_tax_amounts.rate.jurisdiction(string, nullable) Tax jurisdiction.total_tax_amounts.rate.percentage(float) The percentage associated with the tax rate.
updated(timestamp, nullable) Time at which the object was last updated. Measured in seconds since the Unix epoch.
The TerminalHardwareOrder object ​
json
{
"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": "thsm_MfuTjLaPEgXMa4",
"status": "pending",
"tax": 1002,
"total_tax_amounts": [
{
"amount": 1002,
"inclusive": false,
"rate": {
"display_name": "Sales Tax",
"jurisdiction": "LOS ANGELES",
"percentage": 8.25
}
}
],
"updated": null
}