View as Markdown
VirtualSMS icon

VirtualSMS ACTION

Cancel Rental

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
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's VirtualSMS account once, then configure and run Cancel Rental 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: "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)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Cancel Rental inputs
Property Type Description
orderId Order ID string
The ID of an existing rental/activation order. Returned by the Rent Number action and surfaced by the New SMS Received trigger.
Required Dynamic

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
virtualsms-cancel-rental
Version
0.0.2
App
VirtualSMS
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes