# Create Plan — Shift4

> Creates a new plan object. See the documentation

- Key: `shift4-create-plan`
- Type: Action (Write)
- Version: 0.0.3
- App: Shift4 (`shift4`) — https://pipedream.com/apps/shift4.md
- This page (HTML): https://pipedream.com/apps/shift4/actions/create-plan
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/shift4/actions/create-plan/create-plan.mjs

## Description

Creates a new plan object. [See the documentation](https://dev.shift4.com/docs/api#plan-create)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `amount` | `integer` | Yes | Subscription charge amount in minor units of a given currency. For example, 10€ is represented as "1000", and 10¥ is represented as "10". |
| `currency` | `string` | Yes | Subscription charge currency represented as a three-letter ISO currency code. |
| `interval` | `string` | Yes | The interval at which a plan is set to recur. Could be 'day', 'week', 'month', or 'year'. |
| `name` | `string` | Yes | The name of the plan. |
| `intervalCount` | `integer` | No | 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. |
| `billingCycles` | `integer` | No | The number of billing cycles for the payment period. If left blank, the subscription will continue indefinitely. |
| `trialPeriodDays` | `integer` | No | The number of trial period days granted when subscribing a customer to this plan. |
| `recursTo` | `string` | No | The plan to which this plan will recur after the billing cycles have completed. Options are loaded from the connected account. |
| `metadata` | `object` | No | Metadata object. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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": "shift4",
      },
    },
  },
)

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: "shift4-create-plan",
  arguments: {
    amount: 10,
    currency: "Currency",
  },
})
```

**TypeScript**

```ts
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)
```

**cURL**

```bash
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": "shift4-create-plan",
    "configured_props": {
      "shift4": { "authProvisionId": "apn_xxxxxxx" },
      "amount": 10,
      "currency": "Currency"
    }
  }'
```

---

- App: https://pipedream.com/apps/shift4.md · All apps: https://pipedream.com/apps