> ## Documentation Index
> Fetch the complete documentation index at: https://docs.phoneuse.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Read unit delivery and original payment facts

> Requires a first-party interactive organization session with devices:read. Financial commands require an administrator and the configured checkout step-up policy. Network commands also require devices:act, current device authority and explicit consent. New purchase/connection commands require current admission. No credentials are returned. A deployment without the durable composition returns capability_unavailable (422). Renewal, transfer, replace, order target/delivery edits, operation resume and event feeds are not available. Preserve command identity after an uncertain reply and read the original order or operation.

Hosted deployments only. A local checkout does not mount this route, so calling it there is a 404.



## OpenAPI

````yaml /api/openapi.json get /v1/proxy-purchases/{purchaseId}
openapi: 3.1.0
info:
  title: PhoneUse HTTP API
  version: 0.1.0
  summary: >-
    Every HTTP operation the control plane mounts, generated from the app's own
    route table.
  description: >-
    The control plane exposes two HTTP surfaces, and reading the boundary
    between them matters more than reading any single endpoint.


    The CONTROL surface is what your backend and your operators call. It takes a
    bearer token in the `Authorization` header, and two credential channels
    resolve to the same authorization context: an OAuth 2.1 access token for
    interactive clients, or an org scoped API key for headless ones.


    The DEVICE surface, under `/vrx/{runToken}/v1`, is what a worker calls while
    executing one run. Its credential is the run token in the url path, and it
    reads no `Authorization` header at all.


    Device control itself is not REST. An agent taps, swipes and reads the
    screen over the Model Context Protocol at `POST /mcp`, one tool call at a
    time. There is no `POST /v1/devices/{id}/tap`, and if you are looking for
    one, start with the tool reference instead.


    Operations marked `"x-phoneuse-modes": ["hosted"]` exist only on a hosted
    deployment; a local checkout does not mount them.
servers:
  - url: '{origin}'
    description: Your control plane origin.
    variables:
      origin:
        default: https://mcp.phoneuse.com
        enum:
          - https://mcp.phoneuse.com
          - http://127.0.0.1:8788
        description: >-
          The hosted deployment serves the public origin its metadata document
          advertises, and that is the default here. Select the loopback entry
          instead when you are running a local checkout, which serves the port
          `PORT` names.
security: []
tags:
  - name: Robot purchases
    description: >-
      Monthly robot checkout and initial purchase receipts. Delivery remains not
      delivered.
  - name: Managed Proxy
    description: >-
      Organization-owned network resources, original payments and verified phone
      connections.
  - name: Minute billing
    description: Private prepaid minute contract projections and recoverable requests.
  - name: Apps
    description: Save immutable application builds and manage explicit device operations.
  - name: Health
    description: Liveness, unauthenticated.
  - name: MCP
    description: The JSON-RPC endpoint an agent drives devices through.
  - name: Copilot
    description: >-
      Drive a device by chatting. A signed in person's own conversations,
      streamed. Hosted deployments only.
  - name: Discovery
    description: Where to authenticate. Served on hosted deployments only.
  - name: Runs
    description: Start, watch and steer a run.
  - name: API keys
    description: Mint and revoke headless credentials. Hosted deployments only.
  - name: Device surface
    description: What a worker calls with its run token to observe and act.
  - name: Usage
    description: Read your org's own receipts and consumption. Hosted deployments only.
  - name: Devices
    description: Read the fleet your credential can see. Hosted deployments only.
  - name: Notifications
    description: >-
      What a person needs to know when they are not watching, and which emails
      they receive. Hosted deployments only.
  - name: Webhooks
    description: >-
      Subscribe your own system to what happens here, and read what was
      delivered. Hosted deployments only.
  - name: Provisioning
    description: >-
      Whether an organisation is provisioned, and how it becomes so. Hosted
      deployments only, and both operations answer a declared 503 on a
      deployment that cannot provision yet.
paths:
  /v1/proxy-purchases/{purchaseId}:
    get:
      tags:
        - Managed Proxy
      summary: Read unit delivery and original payment facts
      description: >-
        Requires a first-party interactive organization session with
        devices:read. Financial commands require an administrator and the
        configured checkout step-up policy. Network commands also require
        devices:act, current device authority and explicit consent. New
        purchase/connection commands require current admission. No credentials
        are returned. A deployment without the durable composition returns
        capability_unavailable (422). Renewal, transfer, replace, order
        target/delivery edits, operation resume and event feeds are not
        available. Preserve command identity after an uncertain reply and read
        the original order or operation.


        Hosted deployments only. A local checkout does not mount this route, so
        calling it there is a 404.
      operationId: getV1ProxyPurchasesByPurchaseId
      parameters:
        - name: purchaseId
          in: path
          required: true
          description: Opaque organization-scoped identifier.
          schema:
            type: string
      responses:
        '200':
          description: Authorized current projection.
          headers:
            Cache-Control:
              description: Responses are never cached.
              schema:
                type: string
                const: no-store
            X-Request-Id:
              description: Sanitized request correlation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedProxyPurchaseResponse'
        '400':
          description: >-
            Rejected or unavailable; inspect the structured error and retain
            original command identity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedProxyErrorResponse'
        '401':
          description: >-
            Rejected or unavailable; inspect the structured error and retain
            original command identity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedProxyErrorResponse'
        '403':
          description: >-
            Rejected or unavailable; inspect the structured error and retain
            original command identity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedProxyErrorResponse'
        '404':
          description: >-
            Rejected or unavailable; inspect the structured error and retain
            original command identity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedProxyErrorResponse'
        '409':
          description: >-
            Rejected or unavailable; inspect the structured error and retain
            original command identity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedProxyErrorResponse'
        '422':
          description: >-
            Rejected or unavailable; inspect the structured error and retain
            original command identity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedProxyErrorResponse'
        '429':
          description: >-
            Over the request budget for this caller. Hosted deployments only.
            Which budget applied depends on whether this request carried an
            `Authorization` header, not on which endpoint it was aimed at. Wait
            `Retry-After` seconds and retry the same request: the refusal
            happens before any work, so nothing was partially applied. See
            /api/rate-limits.
          headers:
            Retry-After:
              description: >-
                Whole seconds until one request is available again. Computed
                from the caller's own remaining allowance, not a fixed constant.
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The budget in effect for this caller class, in requests per
                minute.
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                Whole requests that were still available when this request was
                admitted. Zero on a 429.
              schema:
                type: string
            RateLimit-Reset:
              description: >-
                Seconds until the allowance is back to full. Longer than
                `Retry-After`, which is the wait for a single request.
              schema:
                type: string
            RateLimit-Policy:
              description: The budget and its window, as `<limit>;w=60`.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitedError'
        '503':
          description: >-
            Rejected or unavailable; inspect the structured error and retain
            original command identity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedProxyErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ManagedProxyPurchaseResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ManagedProxyPurchase'
        snapshot:
          $ref: '#/components/schemas/ManagedProxySnapshot'
        request_id:
          $ref: '#/components/schemas/ManagedProxyId'
      required:
        - data
        - snapshot
        - request_id
      additionalProperties: false
    ManagedProxyErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Stable snake_case code.
              pattern: ^[a-z][a-z0-9_]*$
            message:
              type: string
              description: English, without credentials or raw vendor errors.
            request_id:
              $ref: '#/components/schemas/ManagedProxyId'
            details:
              $ref: '#/components/schemas/ManagedProxyErrorDetails'
            retryable:
              type: boolean
              description: Compatibility with existing reverification_required envelope.
            maxAgeMinutes:
              type: integer
              minimum: 1
          required:
            - code
            - message
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      examples:
        - error:
            code: version_conflict
            message: >-
              The device or resource changed. Refresh its status before
              confirming again.
            request_id: req_demo_2
            details:
              retryable: false
              recovery_action: refresh_and_confirm
              resource_versions:
                px_demo_1: 8
              device_versions:
                dev_demo_a: 13
                dev_demo_b: 4
        - error:
            code: reverification_required
            message: Verify again and retry.
            retryable: true
            maxAgeMinutes: 10
    RateLimitedError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              const: rate_limited
              description: Always `rate_limited` on this response.
            message:
              type: string
              description: >-
                A human readable summary. The numbers are in the headers, not in
                here.
          required:
            - code
            - message
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        Over the request budget. Raised by the rate limiter before any handler
        runs, which is why its code is not one of the action codes: nothing was
        attempted, so no action failed.
    ManagedProxyPurchase:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ManagedProxyId'
        price:
          $ref: '#/components/schemas/ManagedProxyPriceBreakdown'
        checkout:
          anyOf:
            - type: object
              properties:
                url:
                  type: string
                  format: uri
                expires_at:
                  $ref: '#/components/schemas/ManagedProxyTimestamp'
              required:
                - url
                - expires_at
              additionalProperties: false
            - type: 'null'
        quantity:
          type: integer
          minimum: 1
          maximum: 1000
        delivered_quantity:
          type: integer
          minimum: 0
          maximum: 1000
        original_promised_ready_at:
          $ref: '#/components/schemas/ManagedProxyTimestamp'
        next_update_at:
          $ref: '#/components/schemas/ManagedProxyNullableTimestamp'
        last_checked_at:
          $ref: '#/components/schemas/ManagedProxyTimestamp'
        information_stale:
          type: boolean
        support_url:
          type: string
          format: uri
        connect_intent:
          anyOf:
            - type: object
              properties:
                device_id:
                  $ref: '#/components/schemas/ManagedProxyId'
                device_version:
                  $ref: '#/components/schemas/ManagedProxyVersion'
                authorization_ref:
                  $ref: '#/components/schemas/ManagedProxyId'
              required:
                - device_id
                - device_version
                - authorization_ref
              additionalProperties: false
            - type: 'null'
        units:
          type: array
          items:
            $ref: '#/components/schemas/ManagedProxyPurchaseUnit'
          minItems: 1
          maxItems: 1000
        duration_seconds:
          type: integer
          minimum: 1
      required:
        - id
        - price
        - duration_seconds
        - checkout
        - quantity
        - delivered_quantity
        - original_promised_ready_at
        - next_update_at
        - last_checked_at
        - information_stale
        - support_url
        - connect_intent
        - units
      additionalProperties: false
    ManagedProxySnapshot:
      type: object
      properties:
        freshness:
          $ref: '#/components/schemas/ManagedProxyFreshness'
        observed_at:
          $ref: '#/components/schemas/ManagedProxyNullableTimestamp'
        served_at:
          $ref: '#/components/schemas/ManagedProxyTimestamp'
        message:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - freshness
        - observed_at
        - served_at
        - message
      additionalProperties: false
    ManagedProxyId:
      type: string
      description: Opaque organization-bound identifier.
      minLength: 1
      maxLength: 128
      pattern: ^[A-Za-z0-9][A-Za-z0-9_-]*$
    ManagedProxyErrorDetails:
      type: object
      properties:
        retryable:
          type: boolean
        recovery_action:
          type: string
        resource_versions:
          $ref: '#/components/schemas/ManagedProxyVersionMap'
        device_versions:
          $ref: '#/components/schemas/ManagedProxyVersionMap'
        order_id:
          $ref: '#/components/schemas/ManagedProxyId'
        operation_id:
          $ref: '#/components/schemas/ManagedProxyId'
      required: []
      additionalProperties: false
    ManagedProxyPriceBreakdown:
      type: object
      description: >-
        Configured Price amount, tax behavior and known net/tax/total are
        distinct. Unknown calculated values are null. No inferred zero,
        discounts or extra fees.
      properties:
        currency:
          type: string
          pattern: ^[A-Z]{3}$
        subtotal_amount_minor:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          description: >-
            Pre-tax net subtotal when known. Inclusive-price tax calculated
            later can leave this null.
        tax_status:
          type: string
          enum:
            - included
            - calculated
            - calculated_at_checkout
        tax_amount_minor:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        total_amount_minor:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        price_reference:
          $ref: '#/components/schemas/ManagedProxyId'
        configured_price_amount_minor:
          type: integer
          minimum: 0
          description: >-
            Configured Price amount: gross for inclusive tax, net for exclusive
            tax.
        tax_behavior:
          type: string
          enum:
            - inclusive
            - exclusive
      required:
        - currency
        - subtotal_amount_minor
        - tax_status
        - tax_amount_minor
        - total_amount_minor
        - price_reference
        - configured_price_amount_minor
        - tax_behavior
      additionalProperties: false
    ManagedProxyTimestamp:
      type: string
      format: date-time
      pattern: Z$
      description: RFC3339 UTC; UI displays an explicit local timezone.
    ManagedProxyNullableTimestamp:
      anyOf:
        - $ref: '#/components/schemas/ManagedProxyTimestamp'
        - type: 'null'
    ManagedProxyVersion:
      type: integer
      minimum: 1
    ManagedProxyPurchaseUnit:
      type: object
      properties:
        unit_id:
          $ref: '#/components/schemas/ManagedProxyId'
        financial_order_id:
          $ref: '#/components/schemas/ManagedProxyId'
        fulfilment_state:
          type: string
          enum:
            - awaiting_payment
            - preparing
            - delayed
            - delivered
            - terminated
        allowed_actions:
          type: array
          items:
            type: object
            properties:
              action:
                type: string
                const: cancel
              allowed:
                type: boolean
            required:
              - action
              - allowed
            additionalProperties: false
        payment_state:
          type: string
          enum:
            - pending
            - confirmed
            - unknown
            - failed
        refund_state:
          type: string
          enum:
            - none
            - accepted
            - submitted
            - failed
            - succeeded
        proxy_id:
          anyOf:
            - $ref: '#/components/schemas/ManagedProxyId'
            - type: 'null'
        service_ends_at:
          $ref: '#/components/schemas/ManagedProxyNullableTimestamp'
      required:
        - unit_id
        - financial_order_id
        - fulfilment_state
        - allowed_actions
        - payment_state
        - refund_state
        - proxy_id
        - service_ends_at
      additionalProperties: false
    ManagedProxyFreshness:
      type: string
      enum:
        - fresh
        - stale
        - unavailable
    ManagedProxyVersionMap:
      type: object
      maxProperties: 16
      propertyNames:
        $ref: '#/components/schemas/ManagedProxyId'
      additionalProperties:
        $ref: '#/components/schemas/ManagedProxyVersion'
      description: >-
        Exact affected customer resource/device IDs and authoritative versions.
        Server validates completeness; hidden stock is guarded internally.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.