SureCart ACTION
List Purchases
Return a list of purchases. See the documentation
- Action
- Read only
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's SureCart account once, then configure and run List Purchases 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: "surecart-list-purchases",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
surecart: { authProvisionId: "apn_xxxxxxx" },
checkoutIds: ["Checkout IDs"],
createdAtGt: 10,
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "surecart-list-purchases",
"configured_props": {
"surecart": { "authProvisionId": "apn_xxxxxxx" },
"checkoutIds": ["Checkout IDs"],
"createdAtGt": 10
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "surecart",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "surecart-list-purchases",
arguments: {
checkoutIds: ["Checkout IDs"],
createdAtGt: 10,
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
checkoutIds Checkout IDs | string[] | Filter by checkout IDs. Use List Checkouts to find checkout IDs. Example: ["b47ca4c2-6cd2-41d5-aefb-4dc459642c56"] Optional |
createdAtGt Created After (Unix timestamp) | integer | Return purchases created after this Unix timestamp. Example: 1700000000 Optional |
createdAtGte Created At or After (Unix timestamp) | integer | Return purchases created at or after this Unix timestamp. Example: 1700000000 Optional |
createdAtLt Created Before (Unix timestamp) | integer | Return purchases created before this Unix timestamp. Example: 1710000000 Optional |
createdAtLte Created At or Before (Unix timestamp) | integer | Return purchases created at or before this Unix timestamp. Example: 1710000000 Optional |
customerIds Customer IDs | string[] | Filter by customer IDs. Use List Customers to find customer IDs. Example: ["b47ca4c2-6cd2-41d5-aefb-4dc459642c56"] Optional |
downloadable Downloadable | boolean | Filter for purchases that have associated downloads. Optional |
ids IDs | string[] | Filter by specific IDs. Example: ["b47ca4c2-6cd2-41d5-aefb-4dc459642c56", "8f1e2d3c-4b5a-6789-0c1d-2e3f4a5b6c7d"] Optional |
licenseIds License IDs | string[] | Filter by license IDs. Example: ["b47ca4c2-6cd2-41d5-aefb-4dc459642c56"] Optional |
maxResults Max Results | integer | The maximum total number of results to return across all pages. Example: 100 Optional |
liveMode Live Mode | boolean | Filter by live mode ( true) or test mode (false). Optional |
orderIds Order IDs | string[] | Filter by order IDs. Use List Orders to find order IDs. Example: ["b47ca4c2-6cd2-41d5-aefb-4dc459642c56"] Optional |
productIds Product IDs | string[] | Filter by product IDs. Use List Products to find product IDs. Example: ["b47ca4c2-6cd2-41d5-aefb-4dc459642c56"] Optional |
revoked Revoked | boolean | Filter by revocation status. Set to true to return only revoked purchases. Optional |
subscriptionIds Subscription IDs | string[] | Filter by subscription IDs. Use List Subscriptions to find subscription IDs. Example: ["b47ca4c2-6cd2-41d5-aefb-4dc459642c56"] 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
- surecart-list-purchases
- Version
- 1.0.0
- App
- SureCart
- Authentication
- API key
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗