View as Markdown
SegMetrics icon

SegMetrics ACTION

Create Or Update Subscription

Create or update a subscription. See documentation here
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's SegMetrics account once, then configure and run Create Or Update Subscription 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: "segmetrics-create-or-update-subscription",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    segmetrics: { authProvisionId: "apn_xxxxxxx" },
    integrationId: "Integration ID",
    subscriptionId: "Subscription Id",
  },
})

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 Or Update Subscription inputs
Property Type Description
integrationId Integration ID string
The ID of the integration from your Account Settings Page
Required
subscriptionId Subscription Id string
Unique identifier for the subscription
Required
email Contact's Email string
Email address of the contact
Required
amount Subscription Total in Cents integer
Total amount of the subscription in cents
Required
productId Product ID string
Product Id that the subscription applies to
Required
startDate Start Date string
DateTime when the subscription started. E..g 2019-12-03 11:14:32
Required
lastBillDate Last Bill Date string
DateTime when the subscription was last billed. E.g. 2019-12-03 11:14:32
Required
billingCycle Billing Cycle string
The frequency with which a subscription should be billed.
Required
frequency Billing Frequency integer
The number of intervals (specified in the billing_cycle property) between subscription billings. For example, billing_cycle=month and frequency=3 bills every 3 months.
Required

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
segmetrics-create-or-update-subscription
Version
0.0.5
App
SegMetrics
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes