Meter and settle one call streamed against an MPP session
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/commerce/mpp-session/call \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"session": {
"id": "<string>",
"agentId": "<string>",
"principalId": "<string>",
"spendCap": 123,
"maxPerCall": 123,
"currency": "<string>",
"spent": 123,
"callCount": 123,
"consentDigest": "<string>",
"expiresAt": 123,
"createdAt": 123,
"updatedAt": 123,
"revokedAt": 123
},
"call": {
"amount": 123,
"resource": "<string>",
"reference": "<string>"
},
"payTo": "<string>",
"asset": "<string>",
"network": "<string>",
"atomicAmount": "<string>"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/commerce/mpp-session/call"
payload = {
"session": {
"id": "<string>",
"agentId": "<string>",
"principalId": "<string>",
"spendCap": 123,
"maxPerCall": 123,
"currency": "<string>",
"spent": 123,
"callCount": 123,
"consentDigest": "<string>",
"expiresAt": 123,
"createdAt": 123,
"updatedAt": 123,
"revokedAt": 123
},
"call": {
"amount": 123,
"resource": "<string>",
"reference": "<string>"
},
"payTo": "<string>",
"asset": "<string>",
"network": "<string>",
"atomicAmount": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
session: {
id: '<string>',
agentId: '<string>',
principalId: '<string>',
spendCap: 123,
maxPerCall: 123,
currency: '<string>',
spent: 123,
callCount: 123,
consentDigest: '<string>',
expiresAt: 123,
createdAt: 123,
updatedAt: 123,
revokedAt: 123
},
call: {amount: 123, resource: '<string>', reference: '<string>'},
payTo: '<string>',
asset: '<string>',
network: '<string>',
atomicAmount: '<string>'
})
};
fetch('https://api.orbit.devotel.io/api/v1/commerce/mpp-session/call', 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.orbit.devotel.io/api/v1/commerce/mpp-session/call",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'session' => [
'id' => '<string>',
'agentId' => '<string>',
'principalId' => '<string>',
'spendCap' => 123,
'maxPerCall' => 123,
'currency' => '<string>',
'spent' => 123,
'callCount' => 123,
'consentDigest' => '<string>',
'expiresAt' => 123,
'createdAt' => 123,
'updatedAt' => 123,
'revokedAt' => 123
],
'call' => [
'amount' => 123,
'resource' => '<string>',
'reference' => '<string>'
],
'payTo' => '<string>',
'asset' => '<string>',
'network' => '<string>',
'atomicAmount' => '<string>'
]),
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.orbit.devotel.io/api/v1/commerce/mpp-session/call"
payload := strings.NewReader("{\n \"session\": {\n \"id\": \"<string>\",\n \"agentId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"spendCap\": 123,\n \"maxPerCall\": 123,\n \"currency\": \"<string>\",\n \"spent\": 123,\n \"callCount\": 123,\n \"consentDigest\": \"<string>\",\n \"expiresAt\": 123,\n \"createdAt\": 123,\n \"updatedAt\": 123,\n \"revokedAt\": 123\n },\n \"call\": {\n \"amount\": 123,\n \"resource\": \"<string>\",\n \"reference\": \"<string>\"\n },\n \"payTo\": \"<string>\",\n \"asset\": \"<string>\",\n \"network\": \"<string>\",\n \"atomicAmount\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.orbit.devotel.io/api/v1/commerce/mpp-session/call")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"session\": {\n \"id\": \"<string>\",\n \"agentId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"spendCap\": 123,\n \"maxPerCall\": 123,\n \"currency\": \"<string>\",\n \"spent\": 123,\n \"callCount\": 123,\n \"consentDigest\": \"<string>\",\n \"expiresAt\": 123,\n \"createdAt\": 123,\n \"updatedAt\": 123,\n \"revokedAt\": 123\n },\n \"call\": {\n \"amount\": 123,\n \"resource\": \"<string>\",\n \"reference\": \"<string>\"\n },\n \"payTo\": \"<string>\",\n \"asset\": \"<string>\",\n \"network\": \"<string>\",\n \"atomicAmount\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/commerce/mpp-session/call")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"session\": {\n \"id\": \"<string>\",\n \"agentId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"spendCap\": 123,\n \"maxPerCall\": 123,\n \"currency\": \"<string>\",\n \"spent\": 123,\n \"callCount\": 123,\n \"consentDigest\": \"<string>\",\n \"expiresAt\": 123,\n \"createdAt\": 123,\n \"updatedAt\": 123,\n \"revokedAt\": 123\n },\n \"call\": {\n \"amount\": 123,\n \"resource\": \"<string>\",\n \"reference\": \"<string>\"\n },\n \"payTo\": \"<string>\",\n \"asset\": \"<string>\",\n \"network\": \"<string>\",\n \"atomicAmount\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"session": {
"id": "<string>",
"agentId": "<string>",
"principalId": "<string>",
"spendCap": 123,
"maxPerCall": 123,
"currency": "<string>",
"spent": 123,
"callCount": 123,
"status": "active",
"consentDigest": "<string>",
"expiresAt": 123,
"createdAt": 123,
"updatedAt": 123,
"revokedAt": 123
},
"meter": {
"authorized": true,
"reason": "<string>",
"sessionId": "<string>",
"meterId": "<string>",
"amount": 123,
"resource": "<string>",
"reference": "<string>",
"remainingCap": 123
},
"settlement": {
"success": true,
"errorReason": "<string>",
"transaction": "<string>",
"network": "<string>",
"payer": "<string>"
}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Commerce
Meter and settle one call streamed against an MPP session
Meter one agent-tool-call / API request against an MPP session’s remaining cap and settle it via the x402 facilitator. Returns 503 MPP_SETTLEMENT_NOT_ENABLED unless X402_ENABLED=1. A declined call responds 200 with settlement: null. An authorized call with no/invalid X-PAYMENT header responds 402 with an x402 challenge; session spend is committed only once the facilitator reports settlement success.
POST
/
api
/
v1
/
commerce
/
mpp-session
/
call
Meter and settle one call streamed against an MPP session
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/commerce/mpp-session/call \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"session": {
"id": "<string>",
"agentId": "<string>",
"principalId": "<string>",
"spendCap": 123,
"maxPerCall": 123,
"currency": "<string>",
"spent": 123,
"callCount": 123,
"consentDigest": "<string>",
"expiresAt": 123,
"createdAt": 123,
"updatedAt": 123,
"revokedAt": 123
},
"call": {
"amount": 123,
"resource": "<string>",
"reference": "<string>"
},
"payTo": "<string>",
"asset": "<string>",
"network": "<string>",
"atomicAmount": "<string>"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/commerce/mpp-session/call"
payload = {
"session": {
"id": "<string>",
"agentId": "<string>",
"principalId": "<string>",
"spendCap": 123,
"maxPerCall": 123,
"currency": "<string>",
"spent": 123,
"callCount": 123,
"consentDigest": "<string>",
"expiresAt": 123,
"createdAt": 123,
"updatedAt": 123,
"revokedAt": 123
},
"call": {
"amount": 123,
"resource": "<string>",
"reference": "<string>"
},
"payTo": "<string>",
"asset": "<string>",
"network": "<string>",
"atomicAmount": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
session: {
id: '<string>',
agentId: '<string>',
principalId: '<string>',
spendCap: 123,
maxPerCall: 123,
currency: '<string>',
spent: 123,
callCount: 123,
consentDigest: '<string>',
expiresAt: 123,
createdAt: 123,
updatedAt: 123,
revokedAt: 123
},
call: {amount: 123, resource: '<string>', reference: '<string>'},
payTo: '<string>',
asset: '<string>',
network: '<string>',
atomicAmount: '<string>'
})
};
fetch('https://api.orbit.devotel.io/api/v1/commerce/mpp-session/call', 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.orbit.devotel.io/api/v1/commerce/mpp-session/call",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'session' => [
'id' => '<string>',
'agentId' => '<string>',
'principalId' => '<string>',
'spendCap' => 123,
'maxPerCall' => 123,
'currency' => '<string>',
'spent' => 123,
'callCount' => 123,
'consentDigest' => '<string>',
'expiresAt' => 123,
'createdAt' => 123,
'updatedAt' => 123,
'revokedAt' => 123
],
'call' => [
'amount' => 123,
'resource' => '<string>',
'reference' => '<string>'
],
'payTo' => '<string>',
'asset' => '<string>',
'network' => '<string>',
'atomicAmount' => '<string>'
]),
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.orbit.devotel.io/api/v1/commerce/mpp-session/call"
payload := strings.NewReader("{\n \"session\": {\n \"id\": \"<string>\",\n \"agentId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"spendCap\": 123,\n \"maxPerCall\": 123,\n \"currency\": \"<string>\",\n \"spent\": 123,\n \"callCount\": 123,\n \"consentDigest\": \"<string>\",\n \"expiresAt\": 123,\n \"createdAt\": 123,\n \"updatedAt\": 123,\n \"revokedAt\": 123\n },\n \"call\": {\n \"amount\": 123,\n \"resource\": \"<string>\",\n \"reference\": \"<string>\"\n },\n \"payTo\": \"<string>\",\n \"asset\": \"<string>\",\n \"network\": \"<string>\",\n \"atomicAmount\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.orbit.devotel.io/api/v1/commerce/mpp-session/call")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"session\": {\n \"id\": \"<string>\",\n \"agentId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"spendCap\": 123,\n \"maxPerCall\": 123,\n \"currency\": \"<string>\",\n \"spent\": 123,\n \"callCount\": 123,\n \"consentDigest\": \"<string>\",\n \"expiresAt\": 123,\n \"createdAt\": 123,\n \"updatedAt\": 123,\n \"revokedAt\": 123\n },\n \"call\": {\n \"amount\": 123,\n \"resource\": \"<string>\",\n \"reference\": \"<string>\"\n },\n \"payTo\": \"<string>\",\n \"asset\": \"<string>\",\n \"network\": \"<string>\",\n \"atomicAmount\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/commerce/mpp-session/call")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"session\": {\n \"id\": \"<string>\",\n \"agentId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"spendCap\": 123,\n \"maxPerCall\": 123,\n \"currency\": \"<string>\",\n \"spent\": 123,\n \"callCount\": 123,\n \"consentDigest\": \"<string>\",\n \"expiresAt\": 123,\n \"createdAt\": 123,\n \"updatedAt\": 123,\n \"revokedAt\": 123\n },\n \"call\": {\n \"amount\": 123,\n \"resource\": \"<string>\",\n \"reference\": \"<string>\"\n },\n \"payTo\": \"<string>\",\n \"asset\": \"<string>\",\n \"network\": \"<string>\",\n \"atomicAmount\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"session": {
"id": "<string>",
"agentId": "<string>",
"principalId": "<string>",
"spendCap": 123,
"maxPerCall": 123,
"currency": "<string>",
"spent": 123,
"callCount": 123,
"status": "active",
"consentDigest": "<string>",
"expiresAt": 123,
"createdAt": 123,
"updatedAt": 123,
"revokedAt": 123
},
"meter": {
"authorized": true,
"reason": "<string>",
"sessionId": "<string>",
"meterId": "<string>",
"amount": 123,
"resource": "<string>",
"reference": "<string>",
"remainingCap": 123
},
"settlement": {
"success": true,
"errorReason": "<string>",
"transaction": "<string>",
"network": "<string>",
"payer": "<string>"
}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
Required string length:
1 - 255Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
Available options:
true, false Body
application/json
Serializable MPP (Machine Payments Protocol) pre-authorized session snapshot — a spend cap + REQUIRED expiry an agent opens ONCE, then streams metered micropayments against. Carries a SHA-256 consent digest re-verified before every metered call.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The call's price in ATOMIC units of asset, base-10 string.