List Prices
Returns a list of your prices, sorted by price ID in descending order (most recently created first). By default only active prices are returned; pass active=false to list archived ones, or filter to a single product with product. You can also filter by metadata using metadata[key]=value query parameters — for example metadata[lookup_key]=premium-plan to resolve a price by lookup key.
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.
10
Number of objects to skip before returning results.
3
Only return prices where active matches this value.
false
Filter by product ID to return prices for a specific product.
"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
If true, expands the product object in the response.
false
A cursor for use in pagination. starting_after is a price ID that defines your place in the list. For instance, if you make a list request and receive 20 prices, ending with fprice_xyz, your subsequent call can include starting_after=fprice_xyz to fetch the next page.
"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
A cursor for use in pagination. ending_before is a price ID that defines your place in the list. For instance, if you make a list request and receive 20 prices, starting with fprice_abc, your subsequent call can include ending_before=fprice_abc to fetch the previous page.
"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
Filter by metadata key-value pairs using bracket syntax. For example: metadata[lookup_key]=premium-plan. Multiple keys use AND logic.
Response
An envelope wrapping a list of price objects.
An envelope wrapping a list of price objects.
The list of prices.