Update a cost record

PATCH

/api/v1/costs/{id}

curl --request PATCH \
  --url https://example.com/api/v1/costs/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "linkId": "550e8400-e29b-41d4-a716-446655440000", "breakdownKey": "sub_id_2", "breakdownValue": "ad_12345", "periodStart": "2026-03-01", "periodEnd": "2026-03-01", "amount": 42.5, "currency": "USD", "source": "manual", "notes": "example" }'

Authorizations

• bearer

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

linkId

Link this cost applies to. Omit for a workspace-wide (unallocated) cost.

string

Example

550e8400-e29b-41d4-a716-446655440000

breakdownKey

Breakdown dimension key, e.g. “sub_id_2”

string

<= 50 characters

Example

sub_id_2

breakdownValue

Breakdown dimension value, e.g. “ad_12345”

string

<= 255 characters

Example

ad_12345

periodStart

Period start (date)

string

Example

2026-03-01

periodEnd

Period end (date)

string

Example

2026-03-01

amount

number

Example

42.5

currency

string

default: USD <= 3 characters

Example

USD

source

string

default: manual

Allowed values: manual api

notes

string

<= 1000 characters

Responses

200

Media typeapplication/json

object

id

required

string

linkId

object

breakdownKey

object

breakdownValue

object

periodStart

required

string

periodEnd

required

string

amount

required

number

currency

required

string

source

required

string

notes

object

createdAt

required

string

updatedAt

required

string

Example ^generated

{
  "id": "example",
  "linkId": {},
  "breakdownKey": {},
  "breakdownValue": {},
  "periodStart": "example",
  "periodEnd": "example",
  "amount": 1,
  "currency": "example",
  "source": "example",
  "notes": {},
  "createdAt": "example",
  "updatedAt": "example"
}