← Products
get/v1/products/search

Search products

Search for products you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

Query parameters

NameDescription
expandSpecifies which fields in the response should be expanded.
limitA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
pageA cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
query*The search query string. See search query language and the list of supported query fields for products.

Request body

object (no properties in spec)

Response

FieldTypeDescription
data*array<product>
array item fields
FieldTypeDescription
active*boolean

Whether the product is currently available for purchase.

created*integer (unix-time)

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

default_pricestring | price

The ID of the Price object that is the default price for this product.

descriptionstring

The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.

id*string

Unique identifier for the object.

images*array<string>

A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

livemode*boolean

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

marketing_features*array<product_marketing_feature>

A list of up to 15 marketing features for this product. These are displayed in pricing tables.

array item fields
FieldTypeDescription
namestring

The marketing feature name. Up to 80 characters long.

metadata*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.

name*string

The product's name, meant to be displayable to the customer.

object*string

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

package_dimensionspackage_dimensions

The dimensions of this product for shipping purposes.

shippableboolean

Whether this product is shipped (i.e., physical goods).

statement_descriptorstring

Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.

tax_codestring | tax_code

A tax code ID.

unit_labelstring

A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.

updated*integer (unix-time)

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

urlstring

A URL of a publicly-accessible webpage for this product.

has_more*boolean
next_pagestring
object*string

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

total_countinteger

The total number of objects that match the query, only accurate up to 10,000.

url*string