A valid request URL is required to generate request examples{
"id": "<string>",
"deviceId": "<string>",
"status": "active",
"billing": "minute",
"currency": "<string>",
"rateMicrosPerMinute": "<string>",
"contractVersion": "<string>",
"activation": "2023-11-07T05:31:56Z",
"authorizedUntil": "2023-11-07T05:31:56Z",
"settledThrough": "2023-11-07T05:31:56Z",
"authorizationVersion": 2,
"serviceEpoch": 1,
"incarnation": "<string>",
"consumedMicros": "<string>",
"cleanup": "pending",
"canReturn": true,
"canResume": true,
"modelSources": [
"byok"
],
"currentContract": "minute",
"managedModelTerms": {
"model": "<string>",
"label": "<string>",
"currency": "<string>",
"maximumMicros": "<string>",
"priceVersion": "<string>",
"contractVersion": "<string>",
"chargingDisclosure": "<string>"
},
"modelAccess": {
"source": "byok",
"authorized": true,
"label": "<string>",
"chargingDisclosure": "<string>",
"cause": "platform_unavailable",
"sources": [
"byok"
],
"recovery": {
"kind": "contact_support",
"href": "<string>"
},
"managedModelTerms": {
"model": "<string>",
"label": "<string>",
"currency": "<string>",
"maximumMicros": "<string>",
"priceVersion": "<string>",
"contractVersion": "<string>",
"chargingDisclosure": "<string>"
}
},
"interruption": {
"since": "2023-11-07T05:31:56Z",
"financialDisposition": "pending",
"customerMessage": "<string>",
"caseId": "<string>"
},
"chargeEnd": "2023-11-07T05:31:56Z",
"endReason": "returned",
"returnImpact": {
"version": "<string>",
"work": [
{
"id": "<string>",
"label": "<string>"
}
],
"phoneDataNotice": "<string>",
"controller": "<string>"
},
"resumeQuote": {
"quoteId": "<string>",
"sku": "<string>",
"label": "<string>",
"currency": "<string>",
"rateMicrosPerMinute": "<string>",
"initialFundingMicros": "<string>",
"contractVersion": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"quantityMax": 1,
"continuousChargeDisclosure": "<string>",
"modelSources": [
"byok"
],
"model": "<string>",
"region": "<string>",
"managedModelTerms": {
"model": "<string>",
"label": "<string>",
"currency": "<string>",
"maximumMicros": "<string>",
"priceVersion": "<string>",
"contractVersion": "<string>",
"chargingDisclosure": "<string>"
}
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>"
}
}{
"error": {
"code": "rate_limited",
"message": "<string>"
}
}/v1/minute/rentals/:deviceId/return
Private prepaid minute contract. Organization admin first-party session required. Stable request ID binds original operation. Pending or unknown payments do not grant funds.
Hosted deployments only. A local checkout does not mount this route, so calling it there is a 404.
A valid request URL is required to generate request examples{
"id": "<string>",
"deviceId": "<string>",
"status": "active",
"billing": "minute",
"currency": "<string>",
"rateMicrosPerMinute": "<string>",
"contractVersion": "<string>",
"activation": "2023-11-07T05:31:56Z",
"authorizedUntil": "2023-11-07T05:31:56Z",
"settledThrough": "2023-11-07T05:31:56Z",
"authorizationVersion": 2,
"serviceEpoch": 1,
"incarnation": "<string>",
"consumedMicros": "<string>",
"cleanup": "pending",
"canReturn": true,
"canResume": true,
"modelSources": [
"byok"
],
"currentContract": "minute",
"managedModelTerms": {
"model": "<string>",
"label": "<string>",
"currency": "<string>",
"maximumMicros": "<string>",
"priceVersion": "<string>",
"contractVersion": "<string>",
"chargingDisclosure": "<string>"
},
"modelAccess": {
"source": "byok",
"authorized": true,
"label": "<string>",
"chargingDisclosure": "<string>",
"cause": "platform_unavailable",
"sources": [
"byok"
],
"recovery": {
"kind": "contact_support",
"href": "<string>"
},
"managedModelTerms": {
"model": "<string>",
"label": "<string>",
"currency": "<string>",
"maximumMicros": "<string>",
"priceVersion": "<string>",
"contractVersion": "<string>",
"chargingDisclosure": "<string>"
}
},
"interruption": {
"since": "2023-11-07T05:31:56Z",
"financialDisposition": "pending",
"customerMessage": "<string>",
"caseId": "<string>"
},
"chargeEnd": "2023-11-07T05:31:56Z",
"endReason": "returned",
"returnImpact": {
"version": "<string>",
"work": [
{
"id": "<string>",
"label": "<string>"
}
],
"phoneDataNotice": "<string>",
"controller": "<string>"
},
"resumeQuote": {
"quoteId": "<string>",
"sku": "<string>",
"label": "<string>",
"currency": "<string>",
"rateMicrosPerMinute": "<string>",
"initialFundingMicros": "<string>",
"contractVersion": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"quantityMax": 1,
"continuousChargeDisclosure": "<string>",
"modelSources": [
"byok"
],
"model": "<string>",
"region": "<string>",
"managedModelTerms": {
"model": "<string>",
"label": "<string>",
"currency": "<string>",
"maximumMicros": "<string>",
"priceVersion": "<string>",
"contractVersion": "<string>",
"chargingDisclosure": "<string>"
}
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>"
}
}{
"error": {
"code": "rate_limited",
"message": "<string>"
}
}Authorizations
The control surface credential. Send Authorization: Bearer <token>.
Two kinds of token are accepted and they are told apart by shape, not by a separate header. A token beginning pbk_ or puk_ is an org scoped API key, whose public half and secret half are generated together and of which only a hash of the secret is ever stored; anything else is treated as an OAuth 2.1 access token and verified against the authorization server's keys.
Both resolve to the same context: an org, a principal and a set of scopes. Nothing downstream branches on which channel you used, with one deliberate exception, key management, which requires a signed-in person so that a key can never mint another key.
Scopes are enforced when MCP tools are REGISTERED rather than when they are called, so a tool your credential cannot use is absent from tools/list rather than refused mid gesture.
Body
Validated operation fields; monetary amounts are server-quoted.
Response
Authoritative durable projection.