View as Markdown
Shift4 icon

Shift4 ACTION

Create Plan

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

IMPLEMENTATION

Call this tool

Connect a user's Shift4 account once, then configure and run Create Plan 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: "shift4-create-plan",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shift4: { authProvisionId: "apn_xxxxxxx" },
    amount: 10,
    currency: "Currency",
  },
})

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 Plan inputs
Property Type Description
amount Amount integer
Subscription charge amount in minor units of a given currency. For example, 10€ is represented as "1000", and 10¥ is represented as "10".
Required
currency Currency string
Subscription charge currency represented as a three-letter ISO currency code.
Required
interval Interval string
The interval at which a plan is set to recur. Could be 'day', 'week', 'month', or 'year'.
Required
name Name string
The name of the plan.
Required
intervalCount Interval Count integer
The number of intervals between each subscription billing. For example, if interval=month and intervalCount=3, subscriptions created with this plan will be billed every 3 months.
Optional
billingCycles Billing Cycles integer
The number of billing cycles for the payment period. If left blank, the subscription will continue indefinitely.
Optional
trialPeriodDays Trial Period Days integer
The number of trial period days granted when subscribing a customer to this plan.
Optional
recursTo Recurs To string
The plan to which this plan will recur after the billing cycles have completed.
Optional Dynamic
metadata Metadata object
Metadata object.
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
shift4-create-plan
Version
0.0.3
App
Shift4
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes