List all Terminal Hardware SKUs Preview
List all TerminalHardwareSKU
objects.
Parameters
- countrystringRequired
The ISO 3166-1 alpha-2 country code representing the country associated with the SKUs to be retrieved. Available country codes can be listed with the List Country Specs endpoint.
More parameters
- ending_
beforestring A cursor for use in pagination.
ending_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withbefore obj_
, your subsequent call can includebar ending_
in order to fetch the previous page of the list.before=obj_ bar - limitinteger
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- productstring
Only return SKUs for the product specified by this product ID.
- providerenum
The provider associated with this SKU.
Possible enum valuesstripe
The Stripe provider
- starting_
afterstring A cursor for use in pagination.
starting_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withafter obj_
, your subsequent call can includefoo starting_
in order to fetch the next page of the list.after=obj_ foo - statusenum
Only return SKUs that have the given status. Defaults to available.
Possible enum valuesavailable
Available for new orders.
unavailable
Can no longer be used for order creation.
Returns
A dictionary with a data
property that contains an array of terminal hardware SKUs. Each entry in the array is a separate SKU object.
{ "object": "list", "url": "/v1/terminal/hardware_skus", "has_more": false, "data": [ { "id": "thsku_OEu70OWVaQ0DG3", "object": "terminal.hardware_sku", "amount": 450, "country": "US", "currency": "usd", "orderable": 100, "product": "thpr_NGubNsbUoS1oik", "status": "available", "unavailable_after": null } ]}