View as Markdown
Polar icon

Polar ACTION

List Orders

List orders 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 Orders 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-orders",
  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 Orders 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
productBillingType Product Billing Type string
Filter by product billing type. recurring for subscriptions, one_time for one-time purchases.
Optional
customerId Customer string
Select a customer or provide a custom Customer ID (UUID). Search by name, email, or Customer ID (UUID).
Optional Dynamic

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-orders
Version
0.0.2
App
Polar
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes