> 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.

# Cancel at period end

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

Schedules cancellation at the end of the paid period, and records why.

Conversions keep being delivered until then. When Stripe ends the
subscription the workspace becomes unsubscribed: we keep tracking, storing
and reporting its events, but stop sending conversions to its destinations.
The reason is stored on Stripe's subscription as `cancellation_details`.

Reference: https://docs.pivolio.com/api-reference/pivolio/billing/cancel-subscription

## Authentication

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

## Request

### Body (application/json)

This endpoint expects a CancelRequest.

- `reason` (enum, required) — Why a customer cancelled. Mirrors Stripe's canonical set so the data stays comparable if we ever enable `cancellation_reason` on the Customer Portal configuration.
  - Allowed values: `too_expensive`, `missing_features`, `switched_service`, `unused`, `other`
- `comment` (string, optional, nullable)

## 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
{
  "reason": "too_expensive"
}
```

**SDK Code**

```python
import requests

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

payload = { "reason": "too_expensive" }
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/cancel';
const options = {
  method: 'POST',
  headers: {'X-Workspace-Id': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"reason":"too_expensive"}'
};

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/cancel"

	payload := strings.NewReader("{\n  \"reason\": \"too_expensive\"\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/cancel")

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  \"reason\": \"too_expensive\"\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/cancel")
  .header("X-Workspace-Id", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"too_expensive\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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

```csharp
using RestSharp;

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

```swift
import Foundation

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

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/billing/cancel")! 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()
```