View as Markdown
Polar icon

Polar ACTION

List Products

List products according to the specified filters. See the API docs
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Polar account once, then configure and run List Products from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "polar-list-products",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    polar: { authProvisionId: "apn_xxxxxxx" },
    organizationId: "Organization ID",
    productId: "Product",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Products inputs
Property Type Description
organizationId Organization ID string
Filter by organization ID (UUID). Optional — omit to return results across all organizations. Find it in Settings → General under Identifier.
Optional
productId Product string
Select a product or provide a custom Product ID (UUID). Search by product name or Product ID (UUID).
Optional Dynamic
query Query string
Filter by product name.
Optional
isArchived Is Archived boolean
Filter on archived products.
Optional
isRecurring Is Recurring boolean
Filter on recurring products. If true, only subscription tiers are returned. If false, only one-time purchase products are returned.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
polar-list-products
Version
0.0.1
App
Polar
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes