Skip to main content
GET
List Products

Authorizations

Authorization
string
header
required

Use a Bearer token to access this API.

Query Parameters

limit
integer<int32> | null

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Required range: x >= 1
Example:

10

offset
integer<int32> | null

Number of objects to skip before returning results.

Required range: x >= 0
Example:

3

starting_after
string | null

A cursor for use in pagination. starting_after is a product ID that defines your place in the list.

Example:

"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

ending_before
string | null

A cursor for use in pagination. ending_before is a product ID that defines your place in the list.

Example:

"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

active
boolean | null

Only return products where active matches this value.

Example:

false

client_reference_id
string | null

Filter products by their client-provided product identifier.

Example:

"example_value"

metadata
object

Filter by metadata key-value pairs using bracket syntax. For example: metadata[lookup_key]=premium-plan. Multiple keys use AND logic.

Example:

Response

An envelope wrapping a list of product objects.

An envelope wrapping a list of product objects.

products
object[]
required

The list of products.