---
title: "Preview plan change"
description: "Previews switching the business's plan to another tier or billing period: when it takes effect, what it charges now and what it renews at, with a quote that holds the amount for 5 minutes. It takes effect now, prorated, when the tier doesn't drop and the period doesn't shorten; any other switch from the period's end."
---

> 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.

# Preview plan change

Needs the organization:read scope.

## Call

- Tool: `preview_plan_change`
- Scope: `organization:read`
- Reads only.
- Acts on a store.

## Arguments

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `store` | `string` | No | The store to act on. |
| `key` | `"lite_monthly" or "lite_yearly" or "pro_monthly" or "pro_yearly"` | Yes | The plan to switch to, by its price's key: its tier and how often it bills. |

```json
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    },
    "key": {
      "description": "The plan to switch to, by its price's key: its tier and how often it bills.",
      "type": "string",
      "enum": [
        "lite_monthly",
        "lite_yearly",
        "pro_monthly",
        "pro_yearly"
      ]
    }
  },
  "required": [
    "key"
  ],
  "additionalProperties": false
}
```

## Answer

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `quote` | `string` | Yes |  |
| `effective` | `string` | Yes |  |
| `effective_at` | `string` | Yes |  |
| `expires_at` | `string` | Yes |  |
| `currency` | `string` | Yes |  |
| `exponent` | `number` | Yes |  |
| `amount_due` | `number` | Yes |  |
| `tax` | `number` | Yes |  |
| `charge` | `number` | Yes |  |
| `credit` | `number` | Yes |  |
| `other` | `number` | Yes |  |
| `renewal_amount` | `number` | Yes |  |
| `renewal_tax` | `number` | Yes |  |
| `renews_at` | `string` | Yes |  |
| `plan` | `object` | Yes |  |

The answer's full shape is on [its API reference page](/merchant-api/reference/preview-plan-change).

## 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.
- `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. A read marked `transient` may be retried.
- `client-fault`: the server failed around the call. `reached_core` says whether it reached Sherpo; the call may be made 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/preview_plan_change/index.mdx
