Skip to main content

List Products

GET 
/api/v2/products

List products with pagination, sorting, and optional filters.

Query filters (all optional; combine as needed):

  • search_term — partial match on product name or description
  • active — true for active products only, false for inactive only
  • type — product type: RECURRING, ONE_OFF, or METERED (when enabled)
  • currency — only products with an active price in this ISO currency code (e.g. SAR)

External metadata filters (optional, combine with other filters):

  • Use any external metadata key you stored on create/update as a query parameter: external_metadata.<key>=<value>
  • Exact match, case-sensitive. Multiple keys are ANDed.
  • Example: if a consumer was created with "external_metadata": {"segment": "enterprise", "tier": "gold"}, filter with ?external_metadata.segment=enterprise&external_metadata.tier=gold

Pagination: page (default 1), limit (default 10, max 100)

Sorting: sort_field (price, name, created_at; default created_at), sort_direction (asc or desc; default desc)

Example: /api/v2/products?active=true&type=RECURRING&external_metadata.category=saas&currency=SAR

Request​

Responses​

Successful Response