Create a budget

POSThttps://<your-url>/api/v2/budgets

MCP id budgets.storeAlso on this path: GET List budgets

Creates a budget on the project named in the body and returns it with a Location header.

Token scope: api:write:budgets
Without it: 403 insufficient-token-scope.
Permission: budgets::create
Without it: 403 insufficient-permission.
Rate cost: 1 unit, write bucket. A write costs the same whatever view you ask for.
Also: Accepts Idempotency-Key. Never cached: private, no-store. Unknown body keys are refused, never dropped.

Both are checked, scope first. A token never does more than its user. How access is checked

Request

Example: A capped, billable budget

curl -X POST \
  'https://<your-url>/api/v2/budgets' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: <key>' \
  -d '{
    "project_id": 1,
    "description": "Front-end development",
    "budget": 4800,
    "spendable": 4200,
    "is_open": false,
    "is_billable": true
  }'

const response = await fetch('https://<your-url>/api/v2/budgets', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Idempotency-Key': '<key>',
  },
  body: JSON.stringify({
    "project_id": 1,
    "description": "Front-end development",
    "budget": 4800,
    "spendable": 4200,
    "is_open": false,
    "is_billable": true
  }),
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->withHeader('Idempotency-Key', '<key>')
    ->post('https://<your-url>/api/v2/budgets', [
        'project_id' => 1,
        'description' => 'Front-end development',
        'budget' => 4800,
        'spendable' => 4200,
        'is_open' => false,
        'is_billable' => true,
    ]);

import requests
response = requests.request(
    'POST',
    'https://<your-url>/api/v2/budgets',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json', 'Content-Type': 'application/json', 'Idempotency-Key': '<key>'},
    json={'project_id': 1, 'description': 'Front-end development', 'budget': 4800, 'spendable': 4200, 'is_open': False, 'is_billable': True},
)

Response

The shape of the response, with sample values.

{
  "data": {
    "id": 1,
    "project_id": 1,
    "budget_group_id": 1,
    "order_column": 1,
    "description": "Front-end development",
    "start_date": "2026-03-04",
    "end_date": "2026-03-04",
    "budget": 4800,
    "spendable": 4200,
    "status": "active",
    "is_open": false,
    "is_billable": true
  }
}

{
  "type": "https://developers.plnnrly.com/api/v2/problems/idempotency-key-in-flight",
  "title": "Idempotency key in flight",
  "status": 409,
  "detail": "The original request for this Idempotency-Key is still being processed. Retry shortly.",
  "instance": "/api/v2/worklogs",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S"
}

{
  "type": "https://developers.plnnrly.com/api/v2/problems/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "3 fields failed validation.",
  "instance": "/api/v2/worklogs",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S",
  "errors": [
    {
      "pointer": "/date",
      "code": "date_format",
      "detail": "The date does not match the format Y-m-d."
    },
    {
      "pointer": "/minutes",
      "code": "min",
      "detail": "The minutes must be at least 1."
    },
    {
      "pointer": "/description",
      "code": "required",
      "detail": "The description field is required."
    }
  ]
}

6 more fields, listed under Response

project_id is settable here and nowhere else: a budget cannot be moved to another project afterwards. budget and spendable are minutes, not money. The position is set by the server to the highest existing position in the organisation plus one. The write also bumps the owning project's updated_at, so the project's ETag changes and it reappears in an incremental filter[updated_at][gte] window, and it is recorded in the project's activity timeline rather than a timeline of its own.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

Idempotency-Keystring≤ 255

A caller-chosen key that makes this POST safe to retry. Replaying it returns the original response with Idempotency-Replayed: true.

Request body

Unknown keys are refused with 422, naming the key.

project_idinteger → Project.idRequired

Owning project. Settable at create time only; a budget cannot be moved to another project.

descriptionstring≤ 255Required

Budget description as shown in the UI. This is the budget's label and the only field ?q= searches; a budget has no title.

budgetinteger≥ 0Required

Budgeted amount of work, in minutes.

spendableinteger≥ 0

The portion of the budget that may be allocated to tasks, in minutes. A stored value, never decremented by logged time.

statusstring

Lifecycle status of the budget.

active: The default: work is booked against this budget.
inactive: Retired, kept for history and no longer planned against.
blocked: Paused, usually because the project itself is on hold.

New values may be added.

is_openboolean

Whether the budget is open-ended: when true the spendable cap is ignored, plnnrly shows "open" in place of a minute total and the over-budget warning is skipped.

is_billableboolean

Whether time logged on this budget is billable.

start_datedate (YYYY-MM-DD) or null

First day the budget covers, null when it has no start.

end_datedate (YYYY-MM-DD) or null

Last day the budget covers, null when it has no end.

Must be on or after start_date.

budget_group_idinteger or null → BudgetGroup.id

Budget group this budget is filed under, null when ungrouped.

Response 201

Returns a Budget in the detail view.

Headers

ETag: A strong validator of exactly this representation.
Idempotency-Replayed: true when this response was replayed from a stored Idempotency-Key rather than produced by a new write.
Location: The absolute URL of the created or queued resource.
RateLimit: The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy: The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id: The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning