Get cancellation impact

Changed on

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Shows what cancelling your workspace's subscription would affect, without changing anything. Only the workspace owner can call this.

apps.items lists the workspace's apps, with the ones that have the most at stake first: apps that take payments, then apps on a custom domain, then apps with the most active users. The counts are filled in for the first 50 apps only.

When apps.over_limit is true, the workspace has more apps than the Free plan allows. Choose which apps stay published with cancellation_selection in Cancel subscription.

<Note>Missing or invalid credentials, and a read-only token, return 401 here.</Note>

get/api/billing/cancel-subscription/impact

Request

  • Base URL
    https://app.base44.com
  • URL
    https://app.base44.com/api/billing/cancel-subscription/impact
  • Auth
    HTTP bearer

Response

The workspace's apps and what cancelling affects.

backend_functions_stopboolean required

true when the workspace's backend functions stop once the plan ends.

agent_phone_numberstring nullable required

The workspace's active agent phone number, released when the plan ends. null when it has none.

Example response

{
  "apps": {
    "limit": 5,
    "total_count": 7,
    "over_limit": true,
    "items": [
      {
        "active_users_30d": 42,
        "agent_count": 1,
        "automation_count": 2,
        "custom_domain": "nordwind-furniture.com",
        "has_payments": true,
        "id": "6820f3a4e7b91d003c45a1f2",
        "is_published": true,
        "is_user_managed": false,
        "name": "Nordwind Furniture",
        "user_count": 128,
        "workflow_count": 0
      }
    ]
  },
  "backend_functions_stop": true,
  "agent_phone_number": "+14155550123"
}

Changes