A valid request URL is required to generate request examples{
"kind": "started",
"start": {
"id": "<string>",
"state": "waiting_payment",
"model": "<string>",
"region": "<string>",
"identityId": "<string>",
"quantity": 500,
"rateMicrosPerMinute": "<string>",
"startMicrosPerPhone": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"topupId": "<string>",
"paidAt": "2023-11-07T05:31:56Z",
"orderId": "<string>",
"reason": "sold_out"
},
"order": {
"id": "<string>",
"requestId": "<string>",
"quoteId": "<string>",
"status": "waiting",
"canCancel": true,
"units": [
{
"id": "<string>",
"status": "waiting",
"deviceId": "<string>",
"activation": "2023-11-07T05:31:56Z",
"rentalId": "<string>",
"cancelReason": "supplier_sold_out"
}
],
"nextUpdateAt": "2023-11-07T05:31:56Z",
"revision": 2,
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"identity": {
"id": "<string>",
"name": "<string>",
"brand": "<string>",
"androidVersion": "<string>",
"revision": "<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/starts
Start pay-by-the-minute phones in one request. Each phone holds 10 minutes of its rate (startMicrosPerPhone) when it starts. Enough available balance for quantity x startMicrosPerPhone: the order is placed now and the answer is kind started with the order (no payment). Otherwise: a top-up for the missing amount (at least USD 5.00, rounded up to whole cents) is opened with this selection attached, and the answer is kind payment with checkoutUrl. When that payment is confirmed (Stripe event, GET of the start or top-up, or the background sweep) within 1 hour of the selection and nothing replaced it, the order is placed once with the supplier’s offer at that moment; if it cannot start (sold out, rate changed, balance used up) the money stays as balance and state is not_started with a reason. Paid later than 1 hour: balance only (expired). A newer start or top-up replaces a selection still waiting for its payment. Same requestId and selection returns the same start; a different selection under it is 409. The order id is start:.
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{
"kind": "started",
"start": {
"id": "<string>",
"state": "waiting_payment",
"model": "<string>",
"region": "<string>",
"identityId": "<string>",
"quantity": 500,
"rateMicrosPerMinute": "<string>",
"startMicrosPerPhone": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"topupId": "<string>",
"paidAt": "2023-11-07T05:31:56Z",
"orderId": "<string>",
"reason": "sold_out"
},
"order": {
"id": "<string>",
"requestId": "<string>",
"quoteId": "<string>",
"status": "waiting",
"canCancel": true,
"units": [
{
"id": "<string>",
"status": "waiting",
"deviceId": "<string>",
"activation": "2023-11-07T05:31:56Z",
"rentalId": "<string>",
"cancelReason": "supplier_sold_out"
}
],
"nextUpdateAt": "2023-11-07T05:31:56Z",
"revision": 2,
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"identity": {
"id": "<string>",
"name": "<string>",
"brand": "<string>",
"androidVersion": "<string>",
"revision": "<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.