View as Markdown
Baremetrics icon

Baremetrics ACTION

Create Subscription

Subscribe a client to a plan. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Baremetrics account once, then configure and run Create 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: "baremetrics-create-subscription",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    baremetrics: { authProvisionId: "apn_xxxxxxx" },
    sourceId: "Source ID",
    oid: "OID",
  },
})

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 Subscription inputs
Property Type Description
sourceId Source ID string
ID of the source of the customer
Required Dynamic
oid OID string
The unique OID
Required
customerOid Customer OID string
Your unique OID for the customer
Required Dynamic
planOid Plan OID string
Your unique OID for the plan
Required Dynamic
startedAt Started At string
A unix timestamp in seconds of when this subscription started
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
baremetrics-create-subscription
Version
0.0.2
App
Baremetrics
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes