Skip to main content

​
Onboarding a New Customer

You: Create a customer for jane@acme.com with the name “Jane Smith” Assistant: I’ll create that customer for you. Calls create_customer with email: "jane@acme.com", name: "Jane Smith"
The customer has been created:
You: Make sure we have a customer for bob@startup.io — create one if they don’t exist Assistant: I’ll use the ensure tool to check. Calls ensure_customer with email: "bob@startup.io", name: "Bob"
A customer for bob@startup.io already exists: No duplicate was created.
The ensure_customer tool is idempotent — it’s safe to call repeatedly with the same email. It will return the existing customer if one exists, or create a new one if not.

​
Setting Up a Product

You: Create a product called “support-bot” for handling customer support Assistant: Calls create_product with name: "support-bot", description: "Customer support automation"
I’ve created the product: Product: support-bot (prd_P9Q0R1S2)

​
Checking Revenue and Statistics

You: Show me transaction stats for the last 30 days Calls get_transaction_stats with fromDate: "2026-01-11", toDate: "2026-02-11"
Transaction statistics for the last 30 days:
MetricValue
Total transactions84
Successful79
Failed3
Refunded2
Total revenue$3,871.00
You: How much revenue has the support-bot product generated? Calls get_product_balance with productRef: "prd_P9Q0R1S2"
The support-bot product has generated $892.50 in revenue.

​
Managing Purchases

You: What purchases does customer cus_A1B2C3D4 have? Calls get_purchases_by_customer with customerRef: "cus_A1B2C3D4"
Jane Smith has 1 active purchase:
  • Plan: Pro ($49/month)
  • Status: Active
  • Started: 2026-01-15
  • Next billing: 2026-02-15
You: Cancel that renewal — the customer requested a downgrade Calls cancel_renewal with purchaseId: "pur_T3U4V5W6", reason: "Customer requested downgrade"
The renewal has been cancelled. Jane Smith will retain access until the end of the current billing period (2026-02-15).

​
Creating a Checkout Session

You: Generate a checkout link for customer cus_X7Y8Z9W0 to purchase the Pro plan Calls create_checkout_session with customerRef: "cus_X7Y8Z9W0", productRef: "prd_P9Q0R1S2", planRef: "pln_K5L6M7N8"
Here’s the checkout URL for Bob: https://checkout.solvapay.com/session/cs_abc123... Send this link to the customer to complete their purchase.

​
Processing a Refund

You: Refund $25 from transaction txn_D7E8F9G0 — the customer was double-charged Calls create_refund with sourceTransactionId: "txn_D7E8F9G0", amount: 2500, reason: "Double charge"
A partial refund of $25.00 has been processed for transaction txn_D7E8F9G0. The refund reference is txn_H1I2J3K4.
For a full refund, simply omit the amount parameter.

​
Usage-Based Billing

You: Record that customer cus_X7Y8Z9W0 made a successful API call to product prd_P9Q0R1S2 Calls record_usage with customerId: "cus_X7Y8Z9W0", productReference: "prd_P9Q0R1S2", actionType: "api_call", units: 1, outcome: "success"
Usage event recorded successfully.
You: Check if that customer has hit their usage limits Calls check_limits with customerRef: "cus_X7Y8Z9W0", productRef: "prd_P9Q0R1S2"
The customer has used 87 of 100 free requests this period. They have 13 requests remaining before they’ll need to upgrade.
You: Record 5 usage events in bulk for today’s batch Calls record_bulk_usage with an array of 5 events
5 usage events recorded successfully.
The record_bulk_usage tool accepts an array of events using the same payload shape as record_usage (customerId, actionType, units, optional productReference, and outcome). Use this for batch processing instead of making individual calls.

​
Customer Self-Service Portal

You: Generate a billing portal link for customer cus_A1B2C3D4 Calls create_customer_session with customerRef: "cus_A1B2C3D4"
Here’s the customer portal URL for Jane Smith: https://billing.solvapay.com/portal/ps_xyz789... The customer can use this link to manage their payment methods, view invoices, and update their purchase.