caliper uidocs

Plan change

Pro

Change plan, billing period or seats and see the money first: credit for unused days, what is due today and what every period costs after. Upgrades start now; downgrades wait for the period to end and list what will be lost.

Installs components/ui/plan-change.tsxDepends on @radix-ui/react-slot, lucide-reactMotion shared motion tokens
pnpm dlx shadcn@latest add @caliper/plan-change

Change plan

You’re on Team, 8 seats, billed monthly. 22 days left in this period.

seats

When to use #

Use it for

  • The upgrade and downgrade step of any subscription product.
  • Seat-based plans where the total moves with the team.

Skip it when

  • Choosing a plan before signing up; use the pricing table.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/plan-change

Adds its 12 files to components/ui/, each with its own stylesheet, and installs their packages. Pro installs with your access token, set up once per project. See Pro access. The first part also adds Caliper UI’s tokens; import them once as in Installation.

Usage #

Import it from your copy of the source. The example behind the preview comes with the source. It is built from prorate and PlanChange.

example.tsx
import { prorate, PlanChange } from "@/components/ui/plan-change"

The worked example comes with Pro

The 37-line example behind the preview opens here with a Pro or Team licence.

Checking your licence…

API reference #

prorate

component
PropTypeDefault
current *BillingPlan—
target *BillingPlan—
currentInterval *BillingInterval—
targetInterval *BillingInterval—
currentSeats *number—
targetSeats *number—
periodStart *string—
periodEnd *string—
today *string—

PlanChange

component
PropTypeDefaultDescription
plans *readonly BillingPlan[]—
currentPlanId *string—
currentInterval *BillingInterval—
seats *number—
periodStart *string—ISO dates of the current billing period.
periodEnd *string—
todaystringnew Date().toISOString().slice(0, 10)
currencystring"EUR"
scheduled{ planId: string; interval: BillingInterval; seats: number; }—A downgrade already waiting for the period end.
onConfirm *(change: { planId: string; interval: BillingInterval; seats: number; proration: Proration; }) => void | Promise<void>—May return a promise; a thrown error is shown and nothing changes.
onCancelScheduled(() => void)—
classNamestring—

Accessibility #

It exposes alert and status semantics, with aria-labelledby, aria-label, aria-hidden and aria-live kept in step with state. Changes that matter are announced through a live region.

No custom key handling; Tab and the native activation keys do the work.

Motion #

Transitions use the shared duration and easing tokens. Under prefers-reduced-motion those tokens collapse to instant and travel distances go to zero, so state changes still happen without movement.