---
title: "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.

Path: Sherpo merchant API › organization

`PUT /v1/stores/{store}/organization/auto_upgrade`

## Authentication

- `bearer`, http, header `Authorization`, scopes: `organization:write`

## Path parameters

- `store` (`setAutoUpgrade.path.store`; string, required) — The store's id.

## Request body

_Required._

- `enabled` (`setAutoUpgrade.enabled`; boolean, required) — 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.

## Example request

```json
{
  "enabled": true
}
```

## Code samples

### cURL

```bash
curl --request PUT \
  --url 'https://api.sherpo.io/merchant/v1/stores/<store>/organization/auto_upgrade' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true
}
'
```

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/v1/stores/<store>/organization/auto_upgrade';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({enabled: true})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sherpo.io/merchant/v1/stores/<store>/organization/auto_upgrade"

payload = { "enabled": True }
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 200

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.

#### Example

```json
{
  "auto_upgrade": true
}
```

- `auto_upgrade` (`setAutoUpgrade.response.200.auto_upgrade`; boolean, required)

### default

A problem; see https://api.sherpo.io/merchant/docs/errors.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "context": {},
  "reached_core": true,
  "core_answer": "string"
}
```

- `type` (`setAutoUpgrade.response.default.type`; string, required)
  - format `uri`
- `title` (`setAutoUpgrade.response.default.title`; string, required)
- `status` (`setAutoUpgrade.response.default.status`; integer, required)
- `detail` (`setAutoUpgrade.response.default.detail`; string, required)
- `code` (`setAutoUpgrade.response.default.code`; string, optional)
- `context` (`setAutoUpgrade.response.default.context`; object, optional)
- `reached_core` (`setAutoUpgrade.response.default.reached_core`; boolean, optional)
- `core_answer` (`setAutoUpgrade.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/merchant-api/reference/set-auto-upgrade/index.md
