Pause Agent
/agents/{agent}/pauseAuthorization
cookieAuth In: cookie
Path Parameters
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/pause" \ -H "Content-Type: application/json" \ -d '{}'{ "company_id": "string", "livemode": true, "status": "active", "enabled_classes": [ { "operation_class": "string", "currencies": [ "string" ], "credit_types": [ "string" ] } ], "limits": [ { "id": "string", "agent_id": "string", "operation_class": "string", "dimension": "action", "window": "day", "timezone": "string", "currency": "string", "credit_type": "string", "max_amount": 0, "max_count": 0, "second_approval_above": 0, "retired": true } ], "usage": [ { "limit_id": "string", "bucket_key": "string", "amount": 0, "count": 0 } ], "always_ask": [ "string" ], "over_limit_behavior": "refuse", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "agent", "name": "string", "created_at": "2019-08-24T14:15:22Z"}Open the cancel flow POST
Customer billing-session cancellation evidence. Offers are recorded only when each is available to this customer now; keys and people are refused.
Pause a subscription for whole periods POST
Customers pause from the billing page when every product allows it; merchants give a reason. Monthly, flexible-billing subscriptions only. No access while paused; the subscription restarts on the restart date with a normal payment. Pauses run to the selected restart date; early resume is unavailable. Customer pause requires both product access_policy.pause_enabled and company customer_self_service.pause (default false). After enabling company pause, customers must sign in again to receive the pause flow; existing sessions do not gain it.