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

Path: Sherpo merchant API › organization

`GET /v1/stores/{store}/organization/plan/change/preview`

## Authentication

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

## Path parameters

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

## Query parameters

- `key` (`previewPlanChange.query.key`; string, required) — The plan to switch to, by its price's key: its tier and how often it bills.
  - one of `"lite_monthly"`, `"lite_yearly"`, `"pro_monthly"`, `"pro_yearly"`

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.sherpo.io/merchant/v1/stores/<store>/organization/plan/change/preview?key=lite_monthly' \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/v1/stores/<store>/organization/plan/change/preview?key=lite_monthly';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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/plan/change/preview?key=lite_monthly"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

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.

#### Example

```json
{
  "quote": "string",
  "effective": "string",
  "effective_at": "string",
  "expires_at": "string",
  "currency": "string",
  "exponent": 0,
  "amount_due": 0,
  "tax": 0,
  "charge": 0,
  "credit": 0,
  "other": 0,
  "renewal_amount": 0,
  "renewal_tax": 0,
  "renews_at": "string",
  "plan": {
    "key": "string",
    "name": "string",
    "tier": "string",
    "interval": "string",
    "quantity": 0
  }
}
```

- `quote` (`previewPlanChange.response.200.quote`; string, required)
- `effective` (`previewPlanChange.response.200.effective`; string, required)
- `effective_at` (`previewPlanChange.response.200.effective_at`; string, required)
- `expires_at` (`previewPlanChange.response.200.expires_at`; string, required)
- `currency` (`previewPlanChange.response.200.currency`; string, required)
- `exponent` (`previewPlanChange.response.200.exponent`; number, required)
- `amount_due` (`previewPlanChange.response.200.amount_due`; number, required)
- `tax` (`previewPlanChange.response.200.tax`; number, required)
- `charge` (`previewPlanChange.response.200.charge`; number, required)
- `credit` (`previewPlanChange.response.200.credit`; number, required)
- `other` (`previewPlanChange.response.200.other`; number, required)
- `renewal_amount` (`previewPlanChange.response.200.renewal_amount`; number, required)
- `renewal_tax` (`previewPlanChange.response.200.renewal_tax`; number, required)
- `renews_at` (`previewPlanChange.response.200.renews_at`; string, required)
- `plan` (`previewPlanChange.response.200.plan`; object, required)
  - `key` (`previewPlanChange.response.200.plan.key`; string, required)
  - `name` (`previewPlanChange.response.200.plan.name`; any of, required)
    - any of: `string`, `null`
  - `tier` (`previewPlanChange.response.200.plan.tier`; string, required)
  - `interval` (`previewPlanChange.response.200.plan.interval`; string, required)
  - `quantity` (`previewPlanChange.response.200.plan.quantity`; number, 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` (`previewPlanChange.response.default.type`; string, required)
  - format `uri`
- `title` (`previewPlanChange.response.default.title`; string, required)
- `status` (`previewPlanChange.response.default.status`; integer, required)
- `detail` (`previewPlanChange.response.default.detail`; string, required)
- `code` (`previewPlanChange.response.default.code`; string, optional)
- `context` (`previewPlanChange.response.default.context`; object, optional)
- `reached_core` (`previewPlanChange.response.default.reached_core`; boolean, optional)
- `core_answer` (`previewPlanChange.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/merchant-api/reference/preview-plan-change/index.md
