# Cancel the workspace's subscription at the end of the billing period

Needs workspace:billing:manage.

> **Note:**

**Not fully described yet.** The API description has no described successful answer for this operation yet. The method, path, sign-in, rate limits and request fields on this page are read from the server's code and are accurate; what a successful call returns is not written down here yet. Until it is, search engines and the agent index leave this page out.

`POST /api/v1/public/workspaces/workspaceId/subscription/cancel-at-period-end`

- Sign-in: A signed-in user's session: send the session id in the x-session-id header.
- Rate limit: Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted).

Needs `workspace:billing:manage`. The workspace keeps access until the period ends; optional cancellation feedback is stored. Refused with 400 when the subscription state does not allow it, and 409 while another change is in progress.

## Request

| Field         | Type   | Required | Constraints | Description |
| ------------- | ------ | -------- | ----------- | ----------- |
| `workspaceId` | string | Yes      | -           | -           |

Send the body as `application/json`. The body is optional.

| Field               | Type   | Required | Constraints                                                                                                                                         | Description |
| ------------------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| `feedback`          | string | No       | one of `"customer_service"`, `"low_quality"`, `"missing_features"`, `"other"`, `"switched_service"`, `"too_complex"`, `"too_expensive"`, `"unused"` | -           |
| `comment`           | string | No       | at most 500 characters                                                                                                                              | -           |
| `retention`         | object | No       | -                                                                                                                                                   | -           |
| `retention.offerId` | string | No       | 1 to 255 characters                                                                                                                                 | -           |
| `retention.outcome` | string | No       | one of `"declined"`                                                                                                                                 | -           |

## Example request

Replace each `YOUR_...` value with your own, and set the credential in the environment variable the sample reads.

```bash title="cURL"
curl -X POST "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/subscription/cancel-at-period-end" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "feedback": "customer_service",
  "comment": "string",
  "retention": {
    "offerId": "YOUR_OFFER_ID",
    "outcome": "declined"
  }
}'
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/subscription/cancel-at-period-end',
  {
    method: 'POST',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      feedback: 'customer_service',
      comment: 'string',
      retention: {
        offerId: 'YOUR_OFFER_ID',
        outcome: 'declined',
      },
    }),
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.text();
```

```python title="Python"
import os

import requests

response = requests.post(
    "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/subscription/cancel-at-period-end",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    json={
        "feedback": "customer_service",
        "comment": "string",
        "retention": {
            "offerId": "YOUR_OFFER_ID",
            "outcome": "declined",
        },
    },
    timeout=30,
)
response.raise_for_status()
data = response.text
```

## Responses

A successful answer is not described yet. The server answers with the status and body its handler sends.

### Any other status

The handler's own answer. Not described yet: response bodies come from captured responses (server/openapi/captured) and overlays (server/openapi/overlays).

## Errors

Each refusal, what it means, and what to do. The request changed nothing.

### 400 Bad Request

**What it means:** The request failed a `validate()` schema, or an id in the path is not a valid id. `path` names the field.

**What to do:** Fix the field the body names in `path` (or read `message`) and send the request again. Nothing was changed.

```json title="Example"
{
  "error": true,
  "success": false,
  "path": "string",
  "message": "string"
}
```

### 401 Unauthorized

**What it means:** The credential is missing, expired or not accepted here, or the caller's role has no grant for `x-permission` (refused with 401 too). The body is the plain text `Unauthorized`, or a JSON body with a `code` where the gate says why.

**What to do:** Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.

```text title="Example"
Unauthorized
```

### 429 Too Many Requests

**What it means:** A rate limit in `x-rateLimit` was reached. `retryAfter` and the `Retry-After` header say how many seconds until the window resets.

**What to do:** Wait the number of seconds in the `Retry-After` header (also `retryAfter` in the body), then retry. Slow down repeated calls.

```json title="Example"
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}
```

## Events

A successful call can send these [webhook events](/webhooks/overview) to the endpoints that subscribe to them:

- [`subscription.cancel_scheduled`](/webhooks/overview#when-each-event-fires)

## Related

- [Workspaces guide](/workspaces/overview): how this part of BuildBase works
- [All Workspaces operations](/http-api/reference/workspaces)
- [API reference](/http-api/reference): every operation, by tag
- [Sign-in and credentials for the HTTP API](/http-api/authentication)
- [How the HTTP API reports errors](/http-api/errors)
- [Make your first call](/http-api/first-call)
- [Error codes](/reference/error-codes): every `code` the API returns
- OpenAPI: operation `workspaces.subscription.cancelAtPeriodEnd.create` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
