Sign in
Products

List 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

get/api/v2/products

Query parameters

pageinteger

Page number, defaults to 1.

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

Size of a page, defaults to 10. Maximum is 100.

search_termstring nullable

Free-text search (case-insensitive, partial match). Matches product name and description. Omit to skip text search. Example: ?search_term=premium.

Free-text search (case-insensitive, partial match). Matches product name and description. Omit to skip text search. Example: ?search_term=premium.

activeboolean nullable

Filter by product active status. true = active only, false = inactive only. Omit to return both. Example: ?active=true.

Filter by product active status. true = active only, false = inactive only. Omit to return both. Example: ?active=true.

type'RECURRING' | 'ONE_OFF' | 'METERED'

Filter by product type. Allowed values: RECURRING, ONE_OFF, METERED (when enabled). Example: ?type=RECURRING.

currencystring nullable

Return only products with an active price in this currency. 3-letter ISO 4217 code. Example: ?currency=SAR.

Return only products with an active price in this currency. 3-letter ISO 4217 code. Example: ?currency=SAR.

sort_fieldstring nullable

Field to sort by, e.g., 'amount', 'scheduled_on'

Field to sort by, e.g., 'amount', 'scheduled_on'

sort_directionstring nullable

Sorting direction ('asc' or 'desc')

Sorting direction ('asc' or 'desc')

Response

Successful Response

Changes