← Products
get/v1/products

List all products

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

Query parameters

NameDescription
activeOnly return products that are active or inactive (e.g., pass false to list all inactive products).
createdOnly return products that were created during the given date interval.
ending_beforeA cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
expandSpecifies which fields in the response should be expanded.
idsOnly return products with the given IDs. Cannot be used with starting_after or ending_before.
limitA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
shippableOnly return products that can be shipped (i.e., physical, not digital products).
starting_afterA cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
urlOnly return products with the given url.

Request body

object (no properties in spec)

Response

FieldTypeDescription
data*array<product>

Details about each object.

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

True if this list has another page of items after this one that can be fetched.

object*string

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

url*string

The URL where this list can be accessed.