# Cancel Rental — VirtualSMS

> Cancel an active rental and refund any unused balance. Cancellation is only possible while the rental is still active and no SMS has been received (or the cancellation policy permits a refund). See the documentation

- Key: `virtualsms-cancel-rental`
- Type: Action (Write)
- Version: 0.0.2
- App: VirtualSMS (`virtualsms`) — https://pipedream.com/apps/virtualsms.md
- This page (HTML): https://pipedream.com/apps/virtualsms/actions/cancel-rental
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/virtualsms/actions/cancel-rental/cancel-rental.mjs

## Description

Cancel an active rental and refund any unused balance. Cancellation is only possible while the rental is still active and no SMS has been received (or the cancellation policy permits a refund). [See the documentation](https://virtualsms.io/docs/api-reference/introduction)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `orderId` | `string` | Yes | The ID of an existing rental/activation order. Returned by the Rent Number action and surfaced by the New SMS Received trigger. Options are loaded from the connected account. |

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

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: "virtualsms-cancel-rental",
  arguments: {
    orderId: "Order ID",
  },
})
```

**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: "virtualsms-cancel-rental",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    virtualsms: { authProvisionId: "apn_xxxxxxx" },
    orderId: "Order ID",
  },
})

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": "virtualsms-cancel-rental",
    "configured_props": {
      "virtualsms": { "authProvisionId": "apn_xxxxxxx" },
      "orderId": "Order ID"
    }
  }'
```

---

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