Update a cost period

curl --request PATCH \
  --url https://www.ruddr.io/api/workspace/cost-periods/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start": "2023-12-25",
  "currency": "<string>",
  "costPerHour": 123,
  "overheadCostPerHour": 123,
  "costPerMonth": 123,
  "overheadCostPerMonth": 123
}
'

import requests

url = "https://www.ruddr.io/api/workspace/cost-periods/{id}"

payload = {
    "start": "2023-12-25",
    "currency": "<string>",
    "costPerHour": 123,
    "overheadCostPerHour": 123,
    "costPerMonth": 123,
    "overheadCostPerMonth": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    start: '2023-12-25',
    currency: '<string>',
    costPerHour: 123,
    overheadCostPerHour: 123,
    costPerMonth: 123,
    overheadCostPerMonth: 123
  })
};

fetch('https://www.ruddr.io/api/workspace/cost-periods/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.ruddr.io/api/workspace/cost-periods/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'start' => '2023-12-25',
    'currency' => '<string>',
    'costPerHour' => 123,
    'overheadCostPerHour' => 123,
    'costPerMonth' => 123,
    'overheadCostPerMonth' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://www.ruddr.io/api/workspace/cost-periods/{id}"

	payload := strings.NewReader("{\n  \"start\": \"2023-12-25\",\n  \"currency\": \"<string>\",\n  \"costPerHour\": 123,\n  \"overheadCostPerHour\": 123,\n  \"costPerMonth\": 123,\n  \"overheadCostPerMonth\": 123\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://www.ruddr.io/api/workspace/cost-periods/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"start\": \"2023-12-25\",\n  \"currency\": \"<string>\",\n  \"costPerHour\": 123,\n  \"overheadCostPerHour\": 123,\n  \"costPerMonth\": 123,\n  \"overheadCostPerMonth\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.ruddr.io/api/workspace/cost-periods/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"start\": \"2023-12-25\",\n  \"currency\": \"<string>\",\n  \"costPerHour\": 123,\n  \"overheadCostPerHour\": 123,\n  \"costPerMonth\": 123,\n  \"overheadCostPerMonth\": 123\n}"

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

{
  "id": "e9b3f207-5c14-4a8d-b2e6-f0d7c8a1e953",
  "isDefault": false,
  "start": "2025-01-01",
  "end": "2025-12-31",
  "currency": "USD",
  "costMethodId": "fixed_monthly",
  "costPerHour": null,
  "overheadCostPerHour": null,
  "totalCostPerHour": null,
  "costPerMonth": 12500,
  "overheadCostPerMonth": 3000,
  "totalCostPerMonth": 15500,
  "createdAt": "2025-01-01T09:00:00.000Z"
}

PATCH

cost-periods

{id}

Update a cost period

curl --request PATCH \
  --url https://www.ruddr.io/api/workspace/cost-periods/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start": "2023-12-25",
  "currency": "<string>",
  "costPerHour": 123,
  "overheadCostPerHour": 123,
  "costPerMonth": 123,
  "overheadCostPerMonth": 123
}
'

import requests

url = "https://www.ruddr.io/api/workspace/cost-periods/{id}"

payload = {
    "start": "2023-12-25",
    "currency": "<string>",
    "costPerHour": 123,
    "overheadCostPerHour": 123,
    "costPerMonth": 123,
    "overheadCostPerMonth": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    start: '2023-12-25',
    currency: '<string>',
    costPerHour: 123,
    overheadCostPerHour: 123,
    costPerMonth: 123,
    overheadCostPerMonth: 123
  })
};

fetch('https://www.ruddr.io/api/workspace/cost-periods/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.ruddr.io/api/workspace/cost-periods/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'start' => '2023-12-25',
    'currency' => '<string>',
    'costPerHour' => 123,
    'overheadCostPerHour' => 123,
    'costPerMonth' => 123,
    'overheadCostPerMonth' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://www.ruddr.io/api/workspace/cost-periods/{id}"

	payload := strings.NewReader("{\n  \"start\": \"2023-12-25\",\n  \"currency\": \"<string>\",\n  \"costPerHour\": 123,\n  \"overheadCostPerHour\": 123,\n  \"costPerMonth\": 123,\n  \"overheadCostPerMonth\": 123\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://www.ruddr.io/api/workspace/cost-periods/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"start\": \"2023-12-25\",\n  \"currency\": \"<string>\",\n  \"costPerHour\": 123,\n  \"overheadCostPerHour\": 123,\n  \"costPerMonth\": 123,\n  \"overheadCostPerMonth\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.ruddr.io/api/workspace/cost-periods/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"start\": \"2023-12-25\",\n  \"currency\": \"<string>\",\n  \"costPerHour\": 123,\n  \"overheadCostPerHour\": 123,\n  \"costPerMonth\": 123,\n  \"overheadCostPerMonth\": 123\n}"

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

{
  "id": "e9b3f207-5c14-4a8d-b2e6-f0d7c8a1e953",
  "isDefault": false,
  "start": "2025-01-01",
  "end": "2025-12-31",
  "currency": "USD",
  "costMethodId": "fixed_monthly",
  "costPerHour": null,
  "overheadCostPerHour": null,
  "totalCostPerHour": null,
  "costPerMonth": 12500,
  "overheadCostPerMonth": 3000,
  "totalCostPerMonth": 15500,
  "createdAt": "2025-01-01T09:00:00.000Z"
}

A period defining the per-hour labor and overhead costs for a member.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

The cost period uuid.

Body

application/json

start

string<date>

The start date for the period. Will be in the form YYYY-MM-DD.

currency

string

The currency code for the cost period.

costMethodId

enum<string>

The cost method used for this period.

Available options:

hourly,

fixed_hourly,

fixed_monthly

costPerHour

number | null

The labor cost per hour.

overheadCostPerHour

number | null

The overhead cost per hour.

costPerMonth

number | null

The labor cost per month.

overheadCostPerMonth

number | null

The overhead cost per month.

Response

200

string

The unique identifier for the object.

isDefault

boolean

Whether this is the default cost period for the member.

start

string<date>

The start date for the period. Will be in the form YYYY-MM-DD.

end

string<date> | null

The end date for the period. Will be in the form YYYY-MM-DD. null if this is the most recent period.

currency

string

The currency code for the cost period.

costMethodId

enum<string>

The cost method used for this period.

Available options:

hourly,

fixed_hourly,

fixed_monthly

costPerHour

number | null

The labor cost per hour. null when costMethodId is fixed_monthly.

overheadCostPerHour

number | null

The overhead cost per hour. null when costMethodId is fixed_monthly.

totalCostPerHour

number | null

The sum of costPerHour and overheadCostPerHour. null when costMethodId is fixed_monthly.

costPerMonth

number | null

The labor cost per month. null when costMethodId is hourly or fixed_hourly.

overheadCostPerMonth

number | null

The overhead cost per month. null when costMethodId is hourly or fixed_hourly.

totalCostPerMonth

number | null

The sum of costPerMonth and overheadCostPerMonth. null when costMethodId is hourly or fixed_hourly.

createdAt

string<date-time>

The timestamp when the object was created.

Get a cost period Delete a cost period

⌘I

Projects

Time

Pipeline

Expenses

Resourcing

Billing

Workspace

Members

Custom Data

Update a cost period

Authorizations

Path Parameters

Body

Response