List Products
Returns a list of your products, sorted by creation date with the most recently created products appearing first. By default only active products are returned; pass active=false to list archived ones. You can also filter by client_reference_id or by metadata using metadata[key]=value query parameters.
Authorizations
Use a Bearer token to access this API.
Query Parameters
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
x >= 110
Number of objects to skip before returning results.
x >= 03
A cursor for use in pagination. starting_after is a product ID that defines your place in the list.
"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
A cursor for use in pagination. ending_before is a product ID that defines your place in the list.
"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
Only return products where active matches this value.
false
Filter products by their client-provided product identifier.
"example_value"
Filter by metadata key-value pairs using bracket syntax. For example: metadata[lookup_key]=premium-plan. Multiple keys use AND logic.
{ "lookup_key": "premium-plan" }Response
Success
An envelope wrapping a list of product objects.
The list of products.