Payments
Get Agent Payment Readiness
Check whether an agent can be armed to take payments, and read its current in-call payment config
GET
Reports whether an agent can be enabled to take card payments during calls, the two preconditions behind that, and — if the payment tool is already enabled — its current guardrails. Use it to discover why enabling is blocked before calling
PUT /v1/agents/{agentId}/payments/tool.
Enabling in-call payments requires both:
- the agent’s organization is charge-ready in Stripe (
can_accept_payments), and - the agent has Twilio SMS configured (
twilio_configured) — the payment link is delivered to the caller by text.
The platform fee is intentionally not returned by this endpoint.
Path Parameters
string
required
UUID of the agent. Must belong to an organization in your account.Example:
aadcdc82-0c96-4171-a812-6d68ae71c44cQuery Parameters
boolean
default:"false"
By default the merchant’s Stripe charge-readiness is served from cache, so this endpoint is cheap to poll. Pass
refresh=true to force a live re-sync from Stripe for this call (slower) — useful right after a merchant finishes onboarding.Response Fields
When
payment_tool_enabled is false, the guardrail and success_url fields report the defaults that would apply if you enabled the tool without overriding them.