---
title: "Preview Upgrade"
method: POST
path: "/v1/billing/preview-upgrade"
tags: ["billing"]
---

# Preview Upgrade

`POST /v1/billing/preview-upgrade`

## Request

- Base URL: `https://api.usekeel.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.usekeel.io/v1/billing/preview-upgrade`
- Auth: none declared

Preview proration for changing an existing subscription's plan.

Returns the prorated amount, credit, and net charge so the frontend
can show a confirmation dialog before executing the change.

## Headers

- `Authorization` string, nullable
- `X-Org-Id` string, nullable

## Request body

- PreviewUpgradeRequest
  - `plan` string, required
  - `billing_cycle` string

## Response `200`

Successful Response

- PreviewUpgradeResponse
  - `current_plan` string, required
  - `new_plan` string, required
  - `billing_cycle` string, required
  - `proration_amount` integer, required
  - `credit_amount` integer, required
  - `amount_due` integer, required
  - `currency` string, required
  - `period_end` integer, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/usekeel/apis/keel-api.md) · [All operations](https://skmtc.dev/usekeel/apis/keel-api/llms.txt) · [OpenAPI document](https://skmtc.dev/usekeel/apis/keel-api/revisions/3191ca10b0ab?raw)