Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.
Parameters
- activeboolean
Only return products that are active or inactive (e.g., pass
false
to list all inactive products).
More parameters
- createdobject
Only return products that were created during the given date interval.
- created.
gtinteger Minimum value to filter by (exclusive)
- created.
gteinteger Minimum value to filter by (inclusive)
- created.
ltinteger Maximum value to filter by (exclusive)
- created.
lteinteger Maximum value to filter by (inclusive)
- 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 - idsarray of strings
Only return products with the given IDs. Cannot be used with starting_after or ending_before.
- limitinteger
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- shippableboolean
Only return products that can be shipped (i.e., physical, not digital products).
- 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 - urlstring
Only return products with the given url.
Returns
A dictionary with a data
property that contains an array of up to limit
products, starting after product starting_
. Each entry in the array is a separate product object. If no more products are available, the resulting array will be empty.
{ "object": "list", "url": "/v1/products", "has_more": false, "data": [ { "id": "prod_NWjs8kKbJWmuuc", "object": "product", "active": true, "created": 1678833149, "default_price": null, "description": null, "images": [], "marketing_features": [], "livemode": false, "metadata": {}, "name": "Gold Plan", "package_dimensions": null, "shippable": null, "statement_descriptor": null, "tax_code": null, "unit_label": null, "updated": 1678833149, "url": null } ]}