Payments
Enable / Disable Agent Payments
Arm or disarm an agent’s ability to take card payments during calls
PUT
Enables or disables the in-call payment tool on an agent. Enabling writes the payment tool and its guardrails into the agent’s configuration — exactly what the voice worker reads at call time to offer payments and text the caller a Stripe link.
Enabling is gated. The request is rejected with
409 unless both preconditions hold:
- the agent’s organization is charge-ready in Stripe (completed Connect onboarding), and
- the agent has Twilio SMS configured (the payment link is delivered by text).
GET /v1/agents/{agentId}/payments/readiness. Disabling (enabled: false) simply removes the tool and is always allowed.
Path Parameters
string
required
UUID of the agent. Must belong to an organization in your account.Example:
aadcdc82-0c96-4171-a812-6d68ae71c44cBody Parameters
boolean
required
true to arm the payment tool, false to remove it.string
HTTPS URL the caller is redirected to after paying. Used only when enabling; defaults to the platform default if omitted. Must be a valid
https:// URL.integer
Largest single charge allowed, in cents. Used only when enabling. Must be between
50 (10,000). Defaults to 50000 ($500).integer
Cumulative cents allowed across one call. Used only when enabling. Must be ≥
max_single_charge_cents and ≤ 1000000 (1,000).integer
Maximum number of payment links in one call. Used only when enabling. Must be between
1 and 20. Defaults to 5.