StrimzStrimz
API Reference

Agents

Configure AutoPay Agent capabilities.

Read config

GET /v1/agents/config

Returns the current AgentMerchantConfig. If you've never touched it, it's lazy-created with defaults on first read.

Update config

PATCH /v1/agents/config
{
  "enabledCapabilities": ["recovery", "cashflow", "pricing_intelligence"],
  "recovery": {
    "gracePeriodHours": 48,
    "strategy": "twice",
    "notificationTemplate": "Hey, your subscription with us couldn't be charged. Top up?"
  },
  "cashflow": {
    "digestEnabled": true,
    "anomalySensitivity": "medium",
    "autoConvertToYield": false,
    "minimumLiquidReserveCents": 50000
  },
  "commerce": {
    "requireHumanApprovalAboveUsdCents": 100000,
    "approvedVendors": ["0x..."],
    "monthlySpendCapUsdCents": 500000
  }
}

Partial update. Only the keys you send are applied.

Anomaly alerts and yield recommendations start on the Starter plan. On Free, changing cashflow.anomalySensitivity or turning on cashflow.autoConvertToYield answers 403 plan_required, and the agent skips both checks. The cash-flow digest works on every plan.

Activity log

GET /v1/agents/activity?capability=recovery&outcome=success

Returns chronological agent actions. Filter by capability, actionType, outcome, subscriptionId, transactionId, jobId.

metadata is a flat object. Token amounts are base-unit strings (6 decimals), one key per currency, and USDC and EURC are never added together; ...Cents values are USD cents. Reports count live-mode activity only, except commerce (see below).

actionTypeMoney keys in metadata
cashflow_digest_sentrevenueUsdc, revenueEurc, feesUsdc, feesEurc, netUsdc, netEurc, plus count and uniqueCustomers across both currencies
cashflow_anomaly_flaggedcurrency, actualRevenue, expectedMean, stddev in that currency, plus zScore. One row per currency and hour
cashflow_yield_convertedbalanceCents, surplusCents, reserveCents from USDC only, plus eurcBalance
commerce_job_completed (stage: monthly_summary)spendUsdc, spendEurc; capUtilisationPct counts USDC only. Commerce jobs carry no mode, so test jobs are included

Rows written before 2026-10 carry revenue, fees, net and totalSpendCents instead, with both currencies added together.

Jobs

Agent escrow (the commerce capability) is coming soon and not available at launch. POST /v1/agents/jobs and POST /v1/agents/jobs/{id}/approve answer 403 capability_unavailable, and so does turning on commerce through PATCH /v1/agents/config. The list and retrieve endpoints still answer.

POST /v1/agents/jobs
{
  "vendorAddress": "0x...",
  "description": "Translate marketing pages",
  "amount": "50000000",
  "currency": "USDC"
}

Auto-approves if amount < commerce.requireHumanApprovalAboveUsdCents; otherwise creates with status proposed.

GET  /v1/agents/jobs
GET  /v1/agents/jobs/{id}
POST /v1/agents/jobs/{id}/approve

Webhook events

EventFires when
subscription.recovery_attemptRecovery emailed a customer
agent.job_proposedA job needs human approval
agent.job_completedA job's escrow was released to the vendor
agent.job_disputedA job was disputed

The three agent.job_* events are not sent while agent escrow is unavailable, and the dashboard does not offer them.

Other agent actions show on the dashboard's agent feed, not as webhooks.

See The AutoPay Agent for the capability-by-capability breakdown.

On this page