Agent Phone Plan
Cancel Agent Phone Plan
Cancel your organization’s Agent Phone Plan immediately, with an optional offboarding survey.
POST
/
billing
/
cancel_agent_phone
curl -X POST https://api.bland.ai/billing/cancel_agent_phone \
-H "authorization: <org-api-key>" \
-H "Content-Type: application/json" \
-d '{
"feedback": {
"use_cases": ["answering_calls"],
"reason": "switching_service",
"reason_detail": "Another voice provider",
"stay_suggestion": "A cheaper tier"
}
}'
curl -X POST https://api.bland.ai/billing/cancel_agent_phone \
-H "authorization: <org-api-key>"
{
"data": {
"name": "agent_phone_basic",
"display_name": "Agent Phone Plan",
"status": "canceled",
"phone_number": "+15551234567",
"cancellation_survey": {
"submit": { "method": "POST", "path": "/billing/cancel_agent_phone/feedback" },
"questions": [
{
"field": "use_cases",
"type": "multi_select",
"question": "What did you mainly use your Agent Phone plan for?",
"options": [
{ "value": "answering_calls", "label": "Answering my business calls" },
{ "value": "booking_appointments", "label": "Booking appointments or reservations" },
{ "value": "outbound_calls", "label": "Making errand or outbound calls for me" },
{ "value": "texting", "label": "Texting" },
{ "value": "testing", "label": "Just testing it out" },
{ "value": "other", "label": "Other" }
]
},
{
"field": "use_case_other",
"type": "text",
"question": "If other, what else did you use it for?"
},
{
"field": "reason",
"type": "single_select",
"question": "What's the main reason you're canceling?",
"options": [
{ "value": "too_expensive", "label": "Too expensive for what I got" },
{ "value": "not_used_enough", "label": "I didn't use it enough" },
{ "value": "did_not_work", "label": "It didn't work the way I expected" },
{ "value": "switching_service", "label": "Switching to a different service" },
{ "value": "short_term", "label": "I only needed it for a short-term project" },
{ "value": "other", "label": "Other" }
]
},
{
"field": "reason_detail",
"type": "text",
"question": "Which service are you switching to, or what's the reason?"
},
{
"field": "stay_suggestion",
"type": "text",
"question": "What would have made you stay?"
}
]
}
},
"errors": null
}
{
"data": null,
"errors": [
{
"error": "CONFLICT",
"message": "This organization does not have an Agent Phone Plan to cancel."
}
]
}
Overview
Cancels your organization’s Agent Phone Plan right away. The $29.99/month charge stops, there’s no refund for the current month, and your included phone number stays on your account. You can answer a short, optional offboarding survey in the same request withfeedback. If you leave it out, the response includes cancellation_survey, which lists the questions and their allowed answers. You can send your answers afterwards with Submit Cancellation Feedback. The survey never affects the cancel.
Requires an organization API key that belongs to an admin or owner of the organization. A personal account key gets
403 FORBIDDEN.If you’re an agent canceling for a person, ask them the survey questions and pass their answers through. Don’t answer on their behalf.
Headers
string
required
Your organization API key.
Body Parameters
object
Optional answers to the offboarding survey. Every field is optional, and blank answers count as no answer. An invalid survey gets
400 BAD_REQUEST and nothing is canceled.Show properties
Show properties
string[]
What the plan was mainly used for. Any of
answering_calls, booking_appointments, outbound_calls, texting, testing, other.string
What else it was used for, when
use_cases includes other. Up to 500 characters.string
The main reason for canceling. One of
too_expensive, not_used_enough, did_not_work, switching_service, short_term, other.string
The service you’re switching to (with
switching_service), or the reason (with other). Up to 500 characters.string
What would have made you stay. Up to 500 characters.
Response
object
Your plan after the cancel.
status is canceled and phone_number is the number you keep.object
Present only when you canceled without
feedback. It lists the survey questions (questions[], each with a field, type, question, and options for the select questions) and where to send the answers (submit). Text answers can be up to 500 characters.null | array
null on success.curl -X POST https://api.bland.ai/billing/cancel_agent_phone \
-H "authorization: <org-api-key>" \
-H "Content-Type: application/json" \
-d '{
"feedback": {
"use_cases": ["answering_calls"],
"reason": "switching_service",
"reason_detail": "Another voice provider",
"stay_suggestion": "A cheaper tier"
}
}'
curl -X POST https://api.bland.ai/billing/cancel_agent_phone \
-H "authorization: <org-api-key>"
{
"data": {
"name": "agent_phone_basic",
"display_name": "Agent Phone Plan",
"status": "canceled",
"phone_number": "+15551234567",
"cancellation_survey": {
"submit": { "method": "POST", "path": "/billing/cancel_agent_phone/feedback" },
"questions": [
{
"field": "use_cases",
"type": "multi_select",
"question": "What did you mainly use your Agent Phone plan for?",
"options": [
{ "value": "answering_calls", "label": "Answering my business calls" },
{ "value": "booking_appointments", "label": "Booking appointments or reservations" },
{ "value": "outbound_calls", "label": "Making errand or outbound calls for me" },
{ "value": "texting", "label": "Texting" },
{ "value": "testing", "label": "Just testing it out" },
{ "value": "other", "label": "Other" }
]
},
{
"field": "use_case_other",
"type": "text",
"question": "If other, what else did you use it for?"
},
{
"field": "reason",
"type": "single_select",
"question": "What's the main reason you're canceling?",
"options": [
{ "value": "too_expensive", "label": "Too expensive for what I got" },
{ "value": "not_used_enough", "label": "I didn't use it enough" },
{ "value": "did_not_work", "label": "It didn't work the way I expected" },
{ "value": "switching_service", "label": "Switching to a different service" },
{ "value": "short_term", "label": "I only needed it for a short-term project" },
{ "value": "other", "label": "Other" }
]
},
{
"field": "reason_detail",
"type": "text",
"question": "Which service are you switching to, or what's the reason?"
},
{
"field": "stay_suggestion",
"type": "text",
"question": "What would have made you stay?"
}
]
}
},
"errors": null
}
{
"data": null,
"errors": [
{
"error": "CONFLICT",
"message": "This organization does not have an Agent Phone Plan to cancel."
}
]
}
Was this page helpful?
⌘I
curl -X POST https://api.bland.ai/billing/cancel_agent_phone \
-H "authorization: <org-api-key>" \
-H "Content-Type: application/json" \
-d '{
"feedback": {
"use_cases": ["answering_calls"],
"reason": "switching_service",
"reason_detail": "Another voice provider",
"stay_suggestion": "A cheaper tier"
}
}'
curl -X POST https://api.bland.ai/billing/cancel_agent_phone \
-H "authorization: <org-api-key>"
{
"data": {
"name": "agent_phone_basic",
"display_name": "Agent Phone Plan",
"status": "canceled",
"phone_number": "+15551234567",
"cancellation_survey": {
"submit": { "method": "POST", "path": "/billing/cancel_agent_phone/feedback" },
"questions": [
{
"field": "use_cases",
"type": "multi_select",
"question": "What did you mainly use your Agent Phone plan for?",
"options": [
{ "value": "answering_calls", "label": "Answering my business calls" },
{ "value": "booking_appointments", "label": "Booking appointments or reservations" },
{ "value": "outbound_calls", "label": "Making errand or outbound calls for me" },
{ "value": "texting", "label": "Texting" },
{ "value": "testing", "label": "Just testing it out" },
{ "value": "other", "label": "Other" }
]
},
{
"field": "use_case_other",
"type": "text",
"question": "If other, what else did you use it for?"
},
{
"field": "reason",
"type": "single_select",
"question": "What's the main reason you're canceling?",
"options": [
{ "value": "too_expensive", "label": "Too expensive for what I got" },
{ "value": "not_used_enough", "label": "I didn't use it enough" },
{ "value": "did_not_work", "label": "It didn't work the way I expected" },
{ "value": "switching_service", "label": "Switching to a different service" },
{ "value": "short_term", "label": "I only needed it for a short-term project" },
{ "value": "other", "label": "Other" }
]
},
{
"field": "reason_detail",
"type": "text",
"question": "Which service are you switching to, or what's the reason?"
},
{
"field": "stay_suggestion",
"type": "text",
"question": "What would have made you stay?"
}
]
}
},
"errors": null
}
{
"data": null,
"errors": [
{
"error": "CONFLICT",
"message": "This organization does not have an Agent Phone Plan to cancel."
}
]
}