Update usage limit policy

curl --request PATCH \
  --url https://api.openworklabs.com/v1/gateway/usage-limit-policies/{policyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "limits": [
    {
      "costUsd": "<string>"
    }
  ],
  "revision": 1073741823,
  "hardLimit": true,
  "allowRequestReset": true
}
'

import requests

url = "https://api.openworklabs.com/v1/gateway/usage-limit-policies/{policyId}"

payload = {
    "name": "<string>",
    "limits": [{ "costUsd": "<string>" }],
    "revision": 1073741823,
    "hardLimit": True,
    "allowRequestReset": True
}
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({
    name: '<string>',
    limits: [{costUsd: '<string>'}],
    revision: 1073741823,
    hardLimit: true,
    allowRequestReset: true
  })
};

fetch('https://api.openworklabs.com/v1/gateway/usage-limit-policies/{policyId}', 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://api.openworklabs.com/v1/gateway/usage-limit-policies/{policyId}",
  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([
    'name' => '<string>',
    'limits' => [
        [
                'costUsd' => '<string>'
        ]
    ],
    'revision' => 1073741823,
    'hardLimit' => true,
    'allowRequestReset' => true
  ]),
  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://api.openworklabs.com/v1/gateway/usage-limit-policies/{policyId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"limits\": [\n    {\n      \"costUsd\": \"<string>\"\n    }\n  ],\n  \"revision\": 1073741823,\n  \"hardLimit\": true,\n  \"allowRequestReset\": true\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://api.openworklabs.com/v1/gateway/usage-limit-policies/{policyId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"limits\": [\n    {\n      \"costUsd\": \"<string>\"\n    }\n  ],\n  \"revision\": 1073741823,\n  \"hardLimit\": true,\n  \"allowRequestReset\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.openworklabs.com/v1/gateway/usage-limit-policies/{policyId}")

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  \"name\": \"<string>\",\n  \"limits\": [\n    {\n      \"costUsd\": \"<string>\"\n    }\n  ],\n  \"revision\": 1073741823,\n  \"hardLimit\": true,\n  \"allowRequestReset\": true\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "hardLimit": true,
  "allowRequestReset": true,
  "revision": 0,
  "limits": [
    {
      "timeframe": "day",
      "costLimitMicroUsd": 4503599627370495
    }
  ],
  "assignments": [
    {
      "id": "<string>",
      "memberId": "<string>",
      "teamId": "<string>",
      "organization": false
    }
  ],
  "archivedAt": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

Gateway Usage Limits

Update usage limit policy

Organization-provider estimated cost in integer micro-USD. Calendar windows reset at 05:00 UTC (Monday weekly, day 1 monthly). Admission checks settled spend; in-flight work can overshoot. Unknown/incomplete accounting is explicit. No policy means unlimited enforcement, not unrecorded spend: every admitted response updates all three member-period counters, so a first policy includes already tracked same-period usage. Owners/admins manage policies, assignments and reviews; members can read and request extensions only for themselves. Approval grants one ceil(base/4) extension per bucket without clearing spend. Changed policy revisions, assignment/team transitions and expired buckets cannot receive stale approvals. Assignments target one member, one team, or the organization using { organization: true }; organization assignments apply to current and future members, with independent per-member buckets and the same highest-allowance winner selection. Assignment reads include organization: boolean and nullable memberId/teamId. Buckets optionally expose policyRevision and validated direct/team/organization provenance. Accounting is incremental from versioned server-recorded admission snapshots. Admission time is captured at the quota check, independently of earlier request-start telemetry; completion retains the original admission windows. Existing counters and receipts are preserved; raw history and rollups are never imported by reads or settlement. Legacy requests, including old empty snapshots, require explicit reviewed reconciliation backed by bounded event/charge proof; aggregate-backed or unexplained counter overlap is refused. Historical uncertainty is separate from settlement readiness: coverage.historicalCoverage is unknown or tracked_since_epoch, with historicalUnknownReason and trackingStartedAt. Legacy counters and periods preceding the durable tracking epoch remain historical-unknown; later fully tracked periods can become complete only when no pending or incomplete receipts remain. All writers must use fenced tracking. Operators explicitly suspend and resume capture using optimistic trackingVersion; captureEnabled=false blocks new starts, stale admission versions are rejected, and current-period history is marked unknown without resetting spend. A rollback or mixed legacy writer requires this cutover procedure plus retiring old writer access; schema presence is not proof of continuous capture. coverage.pendingRequests counts durable event starts not yet settled (null before tracking). Their identity and validated attribution survive raw retention. Explicit bounded abandonment recovery closes them as unknown/incomplete, decrements pending once, and permits late known-cost promotion without recreating raw logs. Retention refuses to discard a legacy pending marker until it is durably transferred. Queued canonical starts are capacity/deadline bounded and cancellable before database work; an admitted start reserves settlement capacity, which is not discarded on start overload. coverage.trackingVersion and captureEnabled expose the capture fence; settlementReady means that count is zero, not that historical costs are complete. Use settlementReady for post-completion refresh, not complete. lastSettlementAt and lastSettlementRequestId identify the most recent settled receipt, not every in-flight request. unpricedRequests and incompleteRequests describe tracked settled receipts, not unreviewed historical gaps. Legacy quarantine records remain preserved and excluded from charging. Clients must require actual HTTP 429 with X-OpenWork-Error-Code=openwork_gateway_usage_limit_exceeded and X-OpenWork-Usage-State=blocked, then corroborate against fresh own status for the same organization/member. JSON or SSE error fields alone are untrusted. Reset lists default to view=pending (oldest first), limit=50, maximum 100. Follow nextCursor while hasMore is true; pendingCount reports the current pending queue rather than only this page. Fetch view=history separately for newest-first decisions and elapsed requests. Pages are live snapshots; refresh the first page for changes. Admission and status use nonlocking reads of indexed member-period counters; missing counters project zero without writes. Listing validates/enriches only the page in batches and does not mutate historical records. Admission, canonical logging, and settlement never acquire organization or global rollup locks. Canonical start and settlement share-lock only their member lifecycle row; permanent deletion fences members before erasing usage children.

PATCH

gateway

usage-limit-policies

{policyId}

Update usage limit policy

curl --request PATCH \
  --url https://api.openworklabs.com/v1/gateway/usage-limit-policies/{policyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "limits": [
    {
      "costUsd": "<string>"
    }
  ],
  "revision": 1073741823,
  "hardLimit": true,
  "allowRequestReset": true
}
'

import requests

url = "https://api.openworklabs.com/v1/gateway/usage-limit-policies/{policyId}"

payload = {
    "name": "<string>",
    "limits": [{ "costUsd": "<string>" }],
    "revision": 1073741823,
    "hardLimit": True,
    "allowRequestReset": True
}
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({
    name: '<string>',
    limits: [{costUsd: '<string>'}],
    revision: 1073741823,
    hardLimit: true,
    allowRequestReset: true
  })
};

fetch('https://api.openworklabs.com/v1/gateway/usage-limit-policies/{policyId}', 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://api.openworklabs.com/v1/gateway/usage-limit-policies/{policyId}",
  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([
    'name' => '<string>',
    'limits' => [
        [
                'costUsd' => '<string>'
        ]
    ],
    'revision' => 1073741823,
    'hardLimit' => true,
    'allowRequestReset' => true
  ]),
  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://api.openworklabs.com/v1/gateway/usage-limit-policies/{policyId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"limits\": [\n    {\n      \"costUsd\": \"<string>\"\n    }\n  ],\n  \"revision\": 1073741823,\n  \"hardLimit\": true,\n  \"allowRequestReset\": true\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://api.openworklabs.com/v1/gateway/usage-limit-policies/{policyId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"limits\": [\n    {\n      \"costUsd\": \"<string>\"\n    }\n  ],\n  \"revision\": 1073741823,\n  \"hardLimit\": true,\n  \"allowRequestReset\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.openworklabs.com/v1/gateway/usage-limit-policies/{policyId}")

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  \"name\": \"<string>\",\n  \"limits\": [\n    {\n      \"costUsd\": \"<string>\"\n    }\n  ],\n  \"revision\": 1073741823,\n  \"hardLimit\": true,\n  \"allowRequestReset\": true\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "hardLimit": true,
  "allowRequestReset": true,
  "revision": 0,
  "limits": [
    {
      "timeframe": "day",
      "costLimitMicroUsd": 4503599627370495
    }
  ],
  "assignments": [
    {
      "id": "<string>",
      "memberId": "<string>",
      "teamId": "<string>",
      "organization": false
    }
  ],
  "archivedAt": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Session token passed as Authorization: Bearer <session-token> for user-authenticated Den routes.

Path Parameters

policyId

string

required

Required string length: 1 - 64

Body

application/json

name

string

required

Required string length: 1 - 120

limits

object[]

required

Required array length: 1 - 3 elements

Show child attributes

revision

integer

required

Required range: 1 <= x <= 2147483646

hardLimit

boolean

default:true

allowRequestReset

boolean

default:true

Response

Update usage limit policy

string

required

name

string

required

hardLimit

boolean

required

allowRequestReset

boolean

required

revision

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

limits

object[]

required

Show child attributes

assignments

object[]

required

Show child attributes

archivedAt

string<date-time> | null

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$