Set plan

Move a service to another available compute plan.

PATCH /api/services/{id}/plan HTTPS

Request & response examples

Request example Server-side

curl --fail-with-body --request PATCH \
  'https://app.helicarrier.xyz/api/services/YOUR_ID/plan' \
  -H "Authorization: Bearer $HELI_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "planKey": "heli-s1"
}'

const response = await fetch(
  "https://app.helicarrier.xyz/api/services/YOUR_ID/plan",
  {
    method: "PATCH",
    headers: {
      Authorization: `Bearer ${process.env.HELI_API_KEY}`,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "planKey": "heli-s1"
    })
  }
);
const data = await response.json();
if (!response.ok) {
  throw new Error(`HTTP ${response.status}: ${data.error}`);
}
// Inspect data; avoid logging secret responses.

import os
import requests

response = requests.request(
    "PATCH",
    "https://app.helicarrier.xyz/api/services/YOUR_ID/plan",
    headers={
        "Authorization": f"Bearer {os.environ['HELI_API_KEY']}"
    },
    json={
      "planKey": "heli-s1"
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
# Inspect data; avoid logging secret responses.

Response example 200

{
  "planKey": "heli-s2",
  "redeploying": true
}

Illustrative values · selected fields

Response details ↓ OpenAPI ↗

Authorization

An account key with access, or a project/service key with settings:write. The resource must be within the key’s project, service, and environment scope.

Authorization: Bearer <key> Key setup ↗

Path parameters

id string required

Service id.

Request body application/json

planKey string required

Plan key, e.g. heli-s2.

Response 200

Returns the selected plan key and whether the change triggers a redeployment. A plan change can affect billing.

Examples show selected response fields with illustrative values. Your response can contain additional fields.

planKey string

Plan identifier from the plan catalog.

redeploying boolean

Whether the operation applied or queued a redeployment.

Errors

400

Invalid parameters. Check the required fields, types, and resource configuration.

401

The API key is missing, invalid, or revoked.

403

The caller or key scope does not permit this operation.

409

The current resource state prevents the operation. Inspect it before retrying.

500

The operation could not be completed. Check resource state before retrying a write.

Error handling and safe retries

ALSO AVAILABLE VIA MCP

`set_plan`

Required MCP arguments: id, planKey. Send path, query, and body fields together as tool arguments.

Connect your agent ↗

curl --fail-with-body --request PATCH \ 'https://app.helicarrier.xyz/api/services/YOUR_ID/plan' \ -H "Authorization: Bearer $HELI_API_KEY" \ -H 'Content-Type: application/json' \ --data '{ "planKey": "heli-s1" }'

import os import requests response = requests.request( "PATCH", "https://app.helicarrier.xyz/api/services/YOUR_ID/plan", headers={ "Authorization": f"Bearer {os.environ['HELI_API_KEY']}" }, json={ "planKey": "heli-s1" }, timeout=30, ) response.raise_for_status() data = response.json() # Inspect data; avoid logging secret responses.