---
title: "Change the org's plan on its existing subscription"
method: POST
path: "/v1/orgs/{org_id}/subscription"
tags: ["billing"]
---

# Change the org's plan on its existing subscription

`POST /v1/orgs/{org_id}/subscription`

## Request

- Base URL: `https://api.wavehouse.cloud`
- URL: `https://api.wavehouse.cloud/v1/orgs/{org_id}/subscription`
- Auth: one of:
  - API key in cookie `whc_session`
  - HTTP bearer
  - API key in header `X-API-Key`

Owner only. Requires a live Stripe subscription — Checkout starts the first one, this moves it. A dearer plan starts now and the period's fee is prorated; a cheaper one starts when the paid period ends (`pending_change`); the free plan cancels at the period's end, and that last invoice still carries the period's usage. Posting the current plan drops a pending change.

## Path parameters

- `org_id` string, required

## Request body

- MeChangeSubscriptionInput
  - `plan_id` string, required: the plan to move this org's subscription to

## Response `200`

OK

- MeSubscriptionView
  - `hosted_billing` boolean, required: true when this deployment takes payment, so Checkout and the billing portal exist
  - `pilot` PilotView, required
    - `active` boolean, required
    - `percent_off` number, double, required: what the provider takes off every invoice; 100 is the pilot override
  - `plan_name` string
  - `standing` BillingStandingView, required
    - `next_step_at` string, date-time: over_limit: when the org is suspended; suspended: when it starts closing
    - `reason` 'non_payment' | 'over_limit'
    - `since` string, date-time
    - `state` 'good' | 'over_limit' | 'suspended', required: over_limit: writes are paused while reads, exports and deletes work; suspended: the engines are stopped and the data is kept
  - `subscription` SubscriptionView, required
    - `cancel_at_period_end` boolean, required
    - `created_at` string, date-time, required
    - `current_period_end` string, date-time, nullable, required
    - `current_period_start` string, date-time, nullable, required: null until the payment provider names a period
    - `has_billing_account` boolean, required: a payment account exists for this org; the billing portal manages it
    - `org_id` string, required
    - `payment_method_brand` string
    - `payment_method_exp_month` integer
    - `payment_method_exp_year` integer
    - `payment_method_last4` string
    - `pending_change` PendingChangeView
      - `effective_at` string, date-time, required
      - `kind` 'downgrade' | 'cancel', required
      - `plan_id` string, required: the plan the org is on once the change lands
    - `plan_change_in_place` boolean, required: true: POST this route moves the plan; false: Checkout starts the first paid subscription
    - `plan_id` string, required
    - `status` 'trialing' | 'active' | 'incomplete' | 'past_due' | 'unpaid', required: the live provider subscription's status; active when the org holds none (Free, a cancel that landed, or a deployment with no provider), because it is simply on its plan
    - `updated_at` string, date-time, required

## Other responses

- `429`: Rate limited, per client IP, API key or org; a client IP is also refused on every route for a while after repeated authentication failures. A limited operation carries RateLimit-Policy and RateLimit on every response; wait Retry-After seconds before retrying.
- `default`: Error

---

[API](https://skmtc.dev/wavehouse/apis/wavehouse-cloud-api.md) · [All operations](https://skmtc.dev/wavehouse/apis/wavehouse-cloud-api/llms.txt) · [OpenAPI document](https://skmtc.dev/wavehouse/apis/wavehouse-cloud-api/revisions/adea029bf505?raw)