View as Markdown
Sperse icon

Sperse ACTION

Create Product

Creates a new product. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Sperse account once, then configure and run Create Product 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: "sperse-create-product",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    sperse: { authProvisionId: "apn_xxxxxxx" },
    name: "Name",
    code: "Product Code",
  },
})

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.

Create Product inputs
Property Type Description
name Name string
The name of the product
Required
code Product Code string
The product code
Required
productType Product Type string
The type of the product
Required
currencyId Currency ID string
The ID of the currency
Required Dynamic
priceOptions Price Options string[]

An array of price option objects. See the documentation

Example:

[
  {
    "type": "Subscription",
    "frequency": "OneTime",
    "fee": 0,
    "customerChoosesPrice": false,
    "credits": 100,
    "trialDayCount": 0,
    "customPeriodCount": 14,
    "customPeriodType": "Days"
  }
]
Required
description Description string
The description of the product
Optional
descriptionHtml Description HTML string
The HTML description of the product
Optional
barCode Bar Code string
The product barcode
Optional
isPublished Is Published boolean
Whether the product is published
Optional
publishDate Publish Date string
The publish date is required if the product is published. Example: 2026-02-16
Optional
groupName Group Name string
The product group name
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
sperse-create-product
Version
0.0.1
App
Sperse
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes