# Preview a YoPrint plan change

```http
PUT https://secure.yoprint.com/v1/api/store/{team_slug}/setting/subscription/plan/preview
```

- API version: v1
- Operation ID: `v1_public_setting_subscription_plan_preview`
- Section: Team settings › [YoPrint subscription](https://developer.yoprint.com/reference/yoprint-subscription.md)
- Web page: https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-plan-preview/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Shows what a plan change would cost before you make it: `amount_due` now and the `ending_balance`, as Stripe calculates them, in thousandths (`69000` is 69.00; see [Money and quantities](/concepts/money-and-quantities/)). It changes nothing.

It works only for a team that already has a subscription; otherwise you get 422 `preview_not_available`. Send only `new_plan`, `config`, `coupon` and `coupon_token`; any other field is refused.

## Permission

The team owner, or a member with the Manage Billing permission. Manage Settings alone is not enough.

## Business rules

- `config` lists the paid extras, each `{type, value}` with `type` `warehouse`, `pricing_group`, `user_limit` or `pricing_rule`, once each, within the plan's limits.
- A `coupon` needs the `coupon_token` from "Check a YoPrint coupon".

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.

## Request body

Content type `application/json`, required.

Fields:

- `new_plan` (string, required): At most 191 characters.
- `config` (array of objects, optional): At most 4 items.
  - Each item:
    - `type` (string, required): One of: `"warehouse"`, `"pricing_group"`, `"user_limit"`, `"pricing_rule"`.
    - `value` (integer, required): Minimum 0. Maximum 1000000.
- `coupon` (string, optional): At most 191 characters.
- `coupon_token` (string, optional): At most 4096 characters.

### Example request

```bash
curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/setting/subscription/plan/preview' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "config": [],
    "new_plan": "starter-monthly-v2"
  }'
```

## Response

`200` Successful response.

Fields:

- `data` (object, required)
  - `amount_due` (integer, required): Minimum 0.
  - `ending_balance` (integer | null, required)
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": {
    "amount_due": 69000,
    "ending_balance": 0
  },
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
  - When: You are not the owner and your role lacks Manage Billing. The body is `{"message": "Insufficient Permission"}`, without the error envelope. Fix: Use the owner's key, or that of a member with Manage Billing.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
- `422` The requested plan preview is invalid or unavailable for this team.
  - When: An extra field (`invalid_plan_preview_context`), a bad `config` (`invalid_plan_config`), an unknown or unavailable plan (`invalid_plan`), a bad coupon (`invalid_coupon`), no subscription to change (`preview_not_available`), or a missing field (`validation_failed`). Fix: Read `error.code`.
- `503` Billing provider configuration or readback is temporarily unavailable.
  - When: Billing is temporarily unavailable (`billing_provider_unavailable`). Fix: Try again later.

## Notes

- Part of your YoPrint subscription: what your shop pays YoPrint, not your customers' payments.
- AI apps (MCP connections) can't call this operation: they get 403 `agent_operation_not_available`. Use a personal API key.

## Related

- [Subscribe to or change your YoPrint plan](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-plan-checkout.md): `POST /v1/api/store/{team_slug}/setting/subscription/plan/checkout`
- [Check a YoPrint coupon](https://developer.yoprint.com/reference/yoprint-subscription/v1-setting-subscription-check-coupon.md): `PUT /v1/api/store/{team_slug}/setting/subscription/check_coupon`