> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.pivolio.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.pivolio.com/_mcp/server.

# Change plan

POST /billing/plan
Content-Type: application/json

Moves the active workspace to another paid plan.

An upgrade is prorated and takes effect immediately; a downgrade is scheduled for
the next renewal (see the billing service). The interval cannot change here —
cancel and re-subscribe instead. Writes nothing on an upgrade: Stripe's webhook
applies the new state and emails the account's billing contacts.

Reference: https://docs.pivolio.com/api-reference/pivolio/billing/change-plan

## Authentication

- `X-Workspace-Id` header (required) — API Key authentication via header

## Request

### Body (application/json)

This endpoint expects a ChangePlanRequest.

- `plan` (enum, required) — A workspace's pricing tier. There is no Free tier: an unsubscribed workspace has no subscription row at all, and its events are tracked and reported but never dispatched.
  - Allowed values: `starter`, `growth`, `scale`
- `interval` (enum, optional) — A subscription's billing cadence.
  - Allowed values: `month`, `year`

## Response

### 204

Successful Response

## Errors

### 422 Unprocessable Entity Error

Validation Error

- `detail` (string, required)
- `code` (string, required)
- `errors` (list of FieldError, optional, nullable)

## Types

### FieldError

- `field` (string, required)
- `message` (string, required)

## Examples

**Request**

```json
{
  "plan": "starter"
}
```

**SDK Code**

```python
import requests

url = "https://api.example.com/billing/plan"

payload = { "plan": "starter" }
headers = {
    "X-Workspace-Id": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.example.com/billing/plan';
const options = {
  method: 'POST',
  headers: {'X-Workspace-Id': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"plan":"starter"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/billing/plan"

	payload := strings.NewReader("{\n  \"plan\": \"starter\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Workspace-Id", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.example.com/billing/plan")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Workspace-Id"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"plan\": \"starter\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.example.com/billing/plan")
  .header("X-Workspace-Id", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"plan\": \"starter\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.example.com/billing/plan', [
  'body' => '{
  "plan": "starter"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-Workspace-Id' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/billing/plan");
var request = new RestRequest(Method.POST);
request.AddHeader("X-Workspace-Id", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"plan\": \"starter\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-Workspace-Id": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["plan": "starter"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/billing/plan")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```