POST Withdraw a consumer order
/api/v1/account/orders/{id}/withdraw
Contracts, orders, invoices and payments are managed in the browser by the verified account owner. Workspace members, support sessions, API tokens, MCP and plugins cannot use these endpoints. Prices, taxes and contract revisions are validated on the server. Existing orders keep their original confirmation.
On this page
Access and permissions
Contracts, orders, invoices and payments are managed in the browser by the verified account owner. Workspace members, support sessions, API tokens, MCP and plugins cannot use these endpoints. Prices, taxes and contract revisions are validated on the server. Existing orders keep their original confirmation.
Browser session: __Host-mb_session cookie.
When using a browser session for a mutation, send the current CSRF token in X-CSRF-Token with the same-site cookie. OAuth consent uses its documented form field.
Parameters and headers
| Field | Location | Type and limits | Required | Meaning |
|---|---|---|---|---|
| id | Path | string; {"format":"uuid"} | Yes | Identifier of the order. |
Request body
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | object; {"additionalProperties":false} | Yes | — |
| $.revision | integer; {"minimum":1} | Yes | — |
| $.confirmed | boolean; {"const":true} | Yes | — |
Responses
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| $.limit | integer | string | No | Resource protection returns HTTP 429 with Retry-After, a limit identifier and scope. Retry only after the waiting time; telemetry retries must preserve IDs and payloads. Rejected telemetry batches are atomic. |
| $.scope | string; {"enum":["owner","actor","free_pool","platform","capacity","network"]} | No | — |
| $.field_errors | array<object>; {"maxItems":64} | No | — |
| $.field_errors[] | object | Yes | — |
| $.field_errors[].path | string; {"maxLength":256} | Yes | — |
| $.field_errors[].message_key | string | Yes | — |
| $.field_errors[].message_params | object; {"additionalProperties":true} | No | — |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| $.limit | integer | string | No | Resource protection returns HTTP 429 with Retry-After, a limit identifier and scope. Retry only after the waiting time; telemetry retries must preserve IDs and payloads. Rejected telemetry batches are atomic. |
| $.scope | string; {"enum":["owner","actor","free_pool","platform","capacity","network"]} | No | — |
| $.field_errors | array<object>; {"maxItems":64} | No | — |
| $.field_errors[] | object | Yes | — |
| $.field_errors[].path | string; {"maxLength":256} | Yes | — |
| $.field_errors[].message_key | string | Yes | — |
| $.field_errors[].message_params | object; {"additionalProperties":true} | No | — |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| $.limit | integer | string | No | Resource protection returns HTTP 429 with Retry-After, a limit identifier and scope. Retry only after the waiting time; telemetry retries must preserve IDs and payloads. Rejected telemetry batches are atomic. |
| $.scope | string; {"enum":["owner","actor","free_pool","platform","capacity","network"]} | No | — |
| $.field_errors | array<object>; {"maxItems":64} | No | — |
| $.field_errors[] | object | Yes | — |
| $.field_errors[].path | string; {"maxLength":256} | Yes | — |
| $.field_errors[].message_key | string | Yes | — |
| $.field_errors[].message_params | object; {"additionalProperties":true} | No | — |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| $.limit | integer | string | No | Resource protection returns HTTP 429 with Retry-After, a limit identifier and scope. Retry only after the waiting time; telemetry retries must preserve IDs and payloads. Rejected telemetry batches are atomic. |
| $.scope | string; {"enum":["owner","actor","free_pool","platform","capacity","network"]} | No | — |
| $.field_errors | array<object>; {"maxItems":64} | No | — |
| $.field_errors[] | object | Yes | — |
| $.field_errors[].path | string; {"maxLength":256} | Yes | — |
| $.field_errors[].message_key | string | Yes | — |
| $.field_errors[].message_params | object; {"additionalProperties":true} | No | — |
application/json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | object; {"additionalProperties":false} | Yes | — |
| $.receipt | string; {"format":"uuid"} | Yes | — |
Retries and asynchronous work
This change does not have a general retry guarantee. If the response is unclear, read the affected resource before trying again. Follow Retry-After waiting times and request new sign-in or action codes when they expire.
HTTP 202 means the background job was accepted. Use the returned job ID to check its status. Download results when the job is complete, or inspect its error or cancellation status.
Request examples
Replace demo IDs, timestamps and placeholders with your own values. For a retry, keep the same IDs, time and content. These examples do not run requests on this page.
Keep login links, codes, cookies and keys private. Do not print them in logs or share them in support requests.
curl --request POST --cookie '__Host-mb_session=<session>' --header 'Origin: https://metribeacon.com' --header 'X-CSRF-Token: <csrf>' --header 'X-MetriBeacon-Session-Context: <context>' --header 'Content-Type: application/json' --data '{"confirmed":true,"revision":1}' 'https://metribeacon.com/api/v1/account/orders/00000000-0000-4000-8000-000000000001/withdraw'import requests
response = requests.request('POST', 'https://metribeacon.com/api/v1/account/orders/00000000-0000-4000-8000-000000000001/withdraw', cookies={'__Host-mb_session': '<session>'}, headers={'Origin': 'https://metribeacon.com', 'X-CSRF-Token': '<csrf>', 'X-MetriBeacon-Session-Context': '<context>'}, json={'confirmed': True, 'revision': 1})
response.raise_for_status()const response = await fetch("/api/v1/account/orders/00000000-0000-4000-8000-000000000001/withdraw", {method: "POST", credentials: 'same-origin', headers: {"Origin": "https://metribeacon.com", "X-CSRF-Token": "<csrf>", "X-MetriBeacon-Session-Context": "<context>", "Content-Type": "application/json"}, body: JSON.stringify({"confirmed": true, "revision": 1}), });package main
import (
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("POST", "https://metribeacon.com/api/v1/account/orders/00000000-0000-4000-8000-000000000001/withdraw", strings.NewReader("{\"confirmed\":true,\"revision\":1}"))
req.Header.Set("Origin", "https://metribeacon.com")
req.Header.Set("X-CSRF-Token", "<csrf>")
req.Header.Set("X-MetriBeacon-Session-Context", "<context>")
req.Header.Set("Cookie", "__Host-mb_session=<session>")
req.Header.Set("Content-Type", "application/json")
response, err := http.DefaultClient.Do(req)
if err != nil { panic(err) }
defer response.Body.Close()
}