# Create Checkout — SureCart

> Create a new checkout session. See the documentation

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

## Description

Create a new checkout session. [See the documentation](https://developer.surecart.com/api-reference/checkouts/create)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `email` | `string` | No | Customer email address. Example: customer@example.com |
| `name` | `string` | No | Full or business name (takes precedence over First/Last Name). Example: Acme Corp |
| `firstName` | `string` | No | Customer first name. Example: Jane |
| `lastName` | `string` | No | Customer last name. Example: Doe |
| `phone` | `string` | No | Customer phone number. Example: +15551234567 |
| `customer` | `string` | Yes | The unique identifier of the customer. Use List Customers to retrieve a list of available customers. |
| `currency` | `string` | No | ISO 4217 currency code for this checkout. Example: usd |
| `liveMode` | `boolean` | No | Filter by live mode (true) or test mode (false). |
| `taxEnabled` | `boolean` | No | Enable tax calculation for this checkout. |
| `taxBehavior` | `string` | No | Whether tax is included in or added on top of the price. |
| `billingMatchesShipping` | `boolean` | No | Use the shipping address as the billing address. |
| `abandonedCheckoutEnabled` | `boolean` | No | Enable abandoned checkout recovery tracking for this session. |
| `externalUrl` | `string` | No | Custom redirect URL for the customer portal. Example: https://mysite.com/thank-you |
| `groupKey` | `string` | No | Dynamic grouping identifier for this checkout. Example: campaign_summer_2024 |
| `billingAddress` | `object` | No | Billing address object. Example: { "city": "New York", "country": "US", "line_1": "123 Main St", "postal_code": "10001", "state": "NY" } |
| `shippingAddress` | `object` | No | Shipping address object. Example: { "city": "New York", "country": "US", "line_1": "123 Main St", "postal_code": "10001", "state": "NY" } |
| `lineItems` | `string` | No | Initial line items for this checkout. Each item requires a price UUID. Example: [{ "price": "price_abc123", "quantity": 1 }] |
| `discount` | `object` | No | Coupon or promotion code to apply. Example: { "coupon": "coup_abc123" } |
| `taxIdentifier` | `object` | No | Tax ID object with number and number_type. Example: { "number": "123456789", "number_type": "eu_vat" } |
| `selectedShippingChoice` | `string` | No | UUID of the pre-selected shipping option. Example: sc_abc123 |
| `metadata` | `object` | No | Additional key-value metadata. Example: { "source": "email_campaign" } |

## 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": "surecart",
      },
    },
  },
)

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: "surecart-create-checkout",
  arguments: {
    email: "Email",
    name: "Name",
  },
})
```

**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: "surecart-create-checkout",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    surecart: { authProvisionId: "apn_xxxxxxx" },
    email: "Email",
    name: "Name",
  },
})

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": "surecart-create-checkout",
    "configured_props": {
      "surecart": { "authProvisionId": "apn_xxxxxxx" },
      "email": "Email",
      "name": "Name"
    }
  }'
```

---

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