Requires the
stripe peer dependency.Quick Start
Config
string
required
Stripe secret API key. Falls back to
STRIPE_SECRET_KEY env var.number
default:"25"
Max items per list operation.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Agentium 4.0.0 · Upgrade from 3.x.
List charges, get customers, create refunds, list subscriptions, and get invoices.
stripe peer dependency.import { Agent, openai } from "@agentium/core";
import { StripeToolkit } from "@agentium/core/toolkits";
const stripe = new StripeToolkit({
secretKey: process.env.STRIPE_SECRET_KEY,
});
const agent = new Agent({
name: "support-agent",
model: openai(process.env.OPENAI_MODEL ?? "gpt-6.1-sol"),
instructions: "Help customers with billing inquiries. Look up charges and process refunds when needed.",
tools: [...stripe.getTools()],
});
const result = await agent.run("Look up customer cus_ABC123 and show their recent charges.");
STRIPE_SECRET_KEY env var.| Tool | Description |
|---|---|
stripe_list_charges | List recent charges, optionally filtered by customer. |
stripe_get_customer | Get customer details — email, name, balance, metadata. |
stripe_create_refund | Create a full or partial refund for a charge. |
stripe_list_subscriptions | List subscriptions filtered by customer or status. |
stripe_get_invoice | Get invoice details including amounts, status, and PDF link. |
npm install stripe
| Variable | Description |
|---|---|
STRIPE_SECRET_KEY | Stripe secret API key (sk_live_... or sk_test_...) |
sk_test_...) during development. Never expose live keys in agent interactions.