How to Use the Getpaid MCP in Vercel AI SDK

Q: How do I use the Getpaid MCP server with the Vercel AI SDK to show payment status?

You'll use streamText and pass it the Getpaid tools. Your agent can call getcheckoutstatus with a session ID, and the SDK will stream the status—like 'paid' or 'pending'—directly into your React components for a live UI update.

Q: Can I create new checkouts with Getpaid and the Vercel AI SDK?

Yes. Your agent calls createcheckoutsession with the product and amount. The tool returns a checkout URL, which you can then render as a link or button in your application.

Q: What's the best way to list customer invoices from Getpaid in a Vercel AI SDK app?

Have your agent call listbillinginvoices with a customer ID. The AI SDK's generateObject function can pipe the list of invoices directly into your UI state, populating a table or list in real-time.

Stream Getpaid payment data directly into your Next.js app. Build live financial UIs with the Vercel AI SDK.

See Vinkius in Action

Works with every AI agent you already use

…and any MCP-compatible client

MCP Servers - Free for Subscribers

Connect Getpaid MCP to Vercel AI SDK

Create your Vinkius account to connect Getpaid to Vercel AI SDK and route execution through our secure gateway. The platform manages server hosting, runtime updates, and security layers. Configuration requires no manual server provisioning.

GDPR Free for Subscribers

Setup Getpaid with Vercel AI SDK

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Build Real-Time Checkout UIs

Use the Vercel AI SDK to stream checkout status directly to your user's screen. When your agent calls `create_checkout_session`, you can immediately show a payment link. No more waiting for a full page reload. While the user pays, your agent can poll `get_checkout_status` in the background. The moment the payment confirms, the hook streams the update, and your UI can change from 'Processing' to 'Paid' without the user even hitting refresh. It's a clean, modern experience.

Live Customer Account Views

Give your support team an internal tool that feels alive. When they ask about a customer, your agent can fetch and stream data from multiple Getpaid tools at once. It pulls `get_customer_details`, `list_billing_invoices`, and `list_billing_subscriptions` in parallel. With the AI SDK, this data doesn't just appear after a spinner. It populates the dashboard field by field as it arrives. Your support reps see the customer's payment history and subscription status build out in front of them, letting them answer questions faster.

Interactive Reporting with this MCP Server

Connect this Getpaid MCP Server to your admin panel. Let your finance team ask questions in plain English, like 'show me all payments from last week.' Your agent uses `list_billing_payments` and streams the results into a table. They can then follow up with 'find the details for payment ID xyz' or 'refund that one.' The agent uses `get_payment_details` or initiates a `refund_billing_payment`, with the UI updating instantly to reflect the action. It turns a static report into an interactive tool.

Setup guide

Set up Getpaid MCP in Vercel AI SDK

Prerequisites

Node.js 18+ and a TypeScript project
ai + @modelcontextprotocol/sdk packages
Active Vinkius subscription with a valid endpoint token

1

Install dependencies

Run npm install ai @modelcontextprotocol/sdk plus your preferred model provider (e.g. @ai-sdk/openai).
2

Create the Streamable HTTP transport

Use StreamableHTTPClientTransport with your Vinkius endpoint URL. Replace [YOUR_TOKEN_HERE] with your token from cloud.vinkius.com.
3

Discover and use tools

Call mcpClient.tools() to auto-discover all Getpaid tools. Pass them directly to generateText() or streamText() — no manual schema definitions needed.
4

Works with any model provider

Swap openai("gpt-4o") for any AI SDK provider — Anthropic, Google, Mistral. The MCP tools work identically across all supported models.

index.ts

import { experimental_createMCPClient as createMCPClient } from "ai";
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp";
import { generateText } from "ai";
import { openai } from "@ai-sdk/openai";

const transport = new StreamableHTTPClientTransport(
  new URL("https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp")
);

const mcpClient = await createMCPClient({ transport });
const tools = await mcpClient.tools();

const { text } = await generateText({
  model: openai("gpt-4o"),
  tools,
  prompt: "List recent Getpaid transactions",
});

console.log(text);
await mcpClient.close();

Get your connection token →

Independent Platform Disclaimer: Vinkius is an independent platform and is not affiliated with, endorsed by, sponsored by, verified by, or otherwise authorized by Getpaid. All third-party trademarks, logos, and brand names are the property of their respective owners. Their use on this website is strictly for informational purposes to identify service compatibility and interoperability.

Why Choose Vinkius

Vinkius connects your tools to AI with real-time monitoring and automatic cost savings — all from one dashboard.

Connect Getpaid now

Real-time monitoring

Live

visibility into every interaction

Connect your favorite tools to your AI and see exactly what's happening — every request, every response, in real time.

Built-in savings

60%

lower AI costs

Vinkius compresses data between your apps and your AI automatically. Lower bills every month — no configuration required.

Single dashboard

One

place for every integration

Every tool your AI connects to, managed from a single screen. One account, complete control.

Common questions about Getpaid MCP in Vercel AI SDK

You'll use `streamText` and pass it the Getpaid tools. Your agent can call `get_checkout_status` with a session ID, and the SDK will stream the status—like 'paid' or 'pending'—directly into your React components for a live UI update.

Yes. Your agent calls `create_checkout_session` with the product and amount. The tool returns a checkout URL, which you can then render as a link or button in your application.

Have your agent call `list_billing_invoices` with a customer ID. The AI SDK's `generateObject` function can pipe the list of invoices directly into your UI state, populating a table or list in real-time.

Yes, all communication is over HTTPS. Vinkius provides a unique endpoint token that authenticates your requests, so your credentials are never exposed in client-side code.

No, the server is ephemeral and stateless. It only proxies requests for customer details, payment metadata, and subscription data to the Getpaid API. It never logs or stores any of your financial transaction data.

Use it with your favorite AI tools

Connect this server to Cursor, Claude, VS Code, and more.

OpenAI Agents SDK sdk-python

Google ADK sdk-python

Pydantic AI sdk-python

Vercel AI SDK sdk-typescript