Chargebee
Pause Chargebee Subscription
Pauses an active subscription, either immediately or at the end of the current term.
Unverified
What the model is told
Pause a Chargebee subscription. This stops renewals until the subscription is resumed by staff. Only use it when the customer has clearly asked to pause. First check the subscription with Get Chargebee Subscription and verify the customer's identity. Then state exactly which subscription will be paused and whether it is immediate or at the end of the term, and ask for an explicit yes. Do not call this tool without that yes. Never use it on a guess. If it fails, tell the customer a colleague will follow up.
Request
POSThttps://YOUR_CHARGEBEE_SITE.chargebee.com/api/v2/subscriptions/{{subscriptionId}}/pause
Headers
Content-Typeapplication/x-www-form-urlencodedAuthorizationBasic YOUR_BASE64_CHARGEBEE_API_KEY
Body
pause_option={{pauseOption}}Parameters
subscriptionId stringThe Chargebee subscription ID.pauseOption stringWhen to pause: immediately or end_of_term.
Engage payload
{
"source": "VOICE_AI",
"tool": {
"id": "f9c164ba-08dd-4a64-98b2-a765d653ed8b",
"type": "HTTP_REQUEST",
"label": "Pause Chargebee Subscription",
"name": "pause_chargebee_subscription",
"customName": false,
"description": "Pause a Chargebee subscription. This stops renewals until the subscription is resumed by staff. Only use it when the customer has clearly asked to pause. First check the subscription with Get Chargebee Subscription and verify the customer's identity. Then state exactly which subscription will be paused and whether it is immediate or at the end of the term, and ask for an explicit yes. Do not call this tool without that yes. Never use it on a guess. If it fails, tell the customer a colleague will follow up.",
"parameters": [
{
"name": "subscriptionId",
"type": "string",
"description": "The Chargebee subscription ID."
},
{
"name": "pauseOption",
"type": "string",
"description": "When to pause: immediately or end_of_term."
}
],
"config": {
"endpoint": {
"method": "POST",
"url": "https://YOUR_CHARGEBEE_SITE.chargebee.com/api/v2/subscriptions/{{subscriptionId}}/pause"
},
"headers": [
{
"name": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"name": "Authorization",
"value": "Basic YOUR_BASE64_CHARGEBEE_API_KEY"
}
],
"body": "pause_option={{pauseOption}}",
"timeout": null
}
}
}IDs are regenerated on every copy.