---
title: "Set plan auto-upgrade"
description: "Turns on or off upgrading automatically when the business goes over a limit: a Lite plan over its customers, storage or members moves to Pro 7 days after it crosses unless it gets back under, with Pro's price prorated to the card on file. Off by default; never for a cancelled plan, a free trial or a failed payment."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sherpo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Set plan auto-upgrade

Needs the organization:write scope.

## Call

- Tool: `set_auto_upgrade`
- Scope: `organization:write`
- Writes, and may change or remove what is there.
- Acts on a store.

## Arguments

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `store` | `string` | No | The store to act on. |
| `enabled` | `boolean` | Yes | Upgrade automatically when the business goes over a limit, off by default: a Lite plan over its customers, storage or members moves to Pro 7 days after it crosses unless it gets back under, at Pro's price for the same period with the prorated charge on the card on file. Pages, menu items, redirects and too many stores never trigger it, and it never applies to a cancelled plan, a free trial or a failed payment. A refused charge goes on with the over-limit steps and emails the owner to upgrade by hand. Only a member with full access sets it. |

```json
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    },
    "enabled": {
      "description": "Upgrade automatically when the business goes over a limit, off by default: a Lite plan over its customers, storage or members moves to Pro 7 days after it crosses unless it gets back under, at Pro's price for the same period with the prorated charge on the card on file.\nPages, menu items, redirects and too many stores never trigger it, and it never applies to a cancelled plan, a free trial or a failed payment.\nA refused charge goes on with the over-limit steps and emails the owner to upgrade by hand. Only a member with full access sets it.",
      "type": "boolean"
    }
  },
  "required": [
    "enabled"
  ],
  "additionalProperties": false
}
```

## Answer

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `auto_upgrade` | `boolean` | Yes |  |

The answer's full shape is on [its API reference page](/merchant-api/reference/set-auto-upgrade).

## Errors

A refused call is a tool error. Its `structuredContent` holds a `code` and its `context`, except for `client-fault`. This tool may answer:

- `invalid`: an argument is malformed; `context.path` names it.
- `invalid` at `["store"]`: `store` is missing while the connection reaches more than one store, or names a store it doesn't reach.
- `conflict`: the call clashes with the current state; `context` names the field and, where it helps, its current value, and for a `from`, `live`, `expect` or version that no longer matches, the argument (`path`) and what it takes (`reason`).
- `not_permitted`: this connection may not make this call. When `context.reason` is `limit`, too many calls: `retry_after` says when to try again.
- `internal` or `unavailable`: the call failed inside Sherpo, and the write may have landed. This write takes no idempotency key, so read the state back before trying again.
- `client-fault`: the server failed around the call. `core_answer` `ok` means the write landed, so don't send it again. When `reached_core` is false, nothing happened and the call may be made again. Otherwise, this write takes no idempotency key, so read the state back before trying again.
- HTTP 403 with `insufficient_scope`: the connection lacks the scope this tool needs.
- HTTP 401 with `invalid_token`: the access token expired or the connection ended. Refresh the token, and connect again if the refresh fails or the new token is refused too.

Any other code may come back too, such as a `conflict` when the state changed under the call. When the answer was already streaming, a 401 or 403 comes back as a tool error with only its text. See [Errors](/merchant-mcp/errors) for every code and its context.

Source: https://docs.sherpo.io/merchant-mcp/tools/set_auto_upgrade/index.mdx
