List managed-compute credit movements

curl --request GET \
  --url https://api.boxrouter.ai/api/v1/credits/usage \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.boxrouter.ai/api/v1/credits/usage', 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.boxrouter.ai/api/v1/credits/usage",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.boxrouter.ai/api/v1/credits/usage"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.boxrouter.ai/api/v1/credits/usage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "amount_nanodollars": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "kind": "sandbox_charge",
      "sandbox_id": "<string>",
      "sandbox_name": "<string>",
      "key_id": "<string>"
    }
  ],
  "next_cursor": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "outcome": "not_started",
    "retry": "safe",
    "retry_after_seconds": 1,
    "details": {
      "selection_version": 1,
      "considered": 1,
      "excluded": [
        {
          "provider": "<string>"
        }
      ],
      "closest": {},
      "nearest": [
        {}
      ],
      "requirement": "<string>",
      "purchase_id": "<string>",
      "preview": {
        "unused": 1,
        "held_excluded": 1,
        "fee": 1,
        "principal": 1,
        "tax": 1,
        "total": 1,
        "card": {
          "brand": "<string>",
          "last4": "<string>",
          "type": "card",
          "email": "jsmith@example.com"
        }
      },
      "quote": {
        "amount": 2,
        "tax": 1,
        "total": 2,
        "address_required": true,
        "fee_minor": 1,
        "missing": [
          "<string>"
        ]
      },
      "redemption": {
        "code": "<string>",
        "amount_nanodollars": "<string>",
        "description": "<string>",
        "redeemed_at": "2023-11-07T05:31:56Z"
      },
      "scope": "workspace",
      "period": "total",
      "limit_nanodollars": 2,
      "requested_nanodollars": 2,
      "sign_in_method": "<string>",
      "masked_email": "<string>",
      "failure_reason": "<string>",
      "names": [
        "<string>"
      ],
      "fields": [
        "preferences.order"
      ],
      "volume_id": "<string>",
      "writer_sandbox_id": "<string>",
      "checkpoint": 2,
      "limit_bytes": 1,
      "observed_bytes": 1,
      "mismatch": {
        "field": "image",
        "recorded": "<string>",
        "requested": "<string>"
      },
      "volume_phase": "check",
      "phase": "code",
      "command": "<string>",
      "exit_code": 123,
      "stderr_tail": "<string>",
      "stdout_tail": "<string>",
      "agent": "<string>",
      "port": 32768,
      "revoked": true,
      "preview_id": "<string>",
      "url": "<string>"
    },
    "doc_url": "<string>",
    "fix": "<string>",
    "operation_id": "<string>",
    "provider": "<string>",
    "native_code": "<string>",
    "native_status": 123,
    "native_message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "outcome": "not_started",
    "retry": "safe",
    "retry_after_seconds": 1,
    "details": {
      "selection_version": 1,
      "considered": 1,
      "excluded": [
        {
          "provider": "<string>"
        }
      ],
      "closest": {},
      "nearest": [
        {}
      ],
      "requirement": "<string>",
      "purchase_id": "<string>",
      "preview": {
        "unused": 1,
        "held_excluded": 1,
        "fee": 1,
        "principal": 1,
        "tax": 1,
        "total": 1,
        "card": {
          "brand": "<string>",
          "last4": "<string>",
          "type": "card",
          "email": "jsmith@example.com"
        }
      },
      "quote": {
        "amount": 2,
        "tax": 1,
        "total": 2,
        "address_required": true,
        "fee_minor": 1,
        "missing": [
          "<string>"
        ]
      },
      "redemption": {
        "code": "<string>",
        "amount_nanodollars": "<string>",
        "description": "<string>",
        "redeemed_at": "2023-11-07T05:31:56Z"
      },
      "scope": "workspace",
      "period": "total",
      "limit_nanodollars": 2,
      "requested_nanodollars": 2,
      "sign_in_method": "<string>",
      "masked_email": "<string>",
      "failure_reason": "<string>",
      "names": [
        "<string>"
      ],
      "fields": [
        "preferences.order"
      ],
      "volume_id": "<string>",
      "writer_sandbox_id": "<string>",
      "checkpoint": 2,
      "limit_bytes": 1,
      "observed_bytes": 1,
      "mismatch": {
        "field": "image",
        "recorded": "<string>",
        "requested": "<string>"
      },
      "volume_phase": "check",
      "phase": "code",
      "command": "<string>",
      "exit_code": 123,
      "stderr_tail": "<string>",
      "stdout_tail": "<string>",
      "agent": "<string>",
      "port": 32768,
      "revoked": true,
      "preview_id": "<string>",
      "url": "<string>"
    },
    "doc_url": "<string>",
    "fix": "<string>",
    "operation_id": "<string>",
    "provider": "<string>",
    "native_code": "<string>",
    "native_status": 123,
    "native_message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "outcome": "not_started",
    "retry": "safe",
    "retry_after_seconds": 1,
    "details": {
      "selection_version": 1,
      "considered": 1,
      "excluded": [
        {
          "provider": "<string>"
        }
      ],
      "closest": {},
      "nearest": [
        {}
      ],
      "requirement": "<string>",
      "purchase_id": "<string>",
      "preview": {
        "unused": 1,
        "held_excluded": 1,
        "fee": 1,
        "principal": 1,
        "tax": 1,
        "total": 1,
        "card": {
          "brand": "<string>",
          "last4": "<string>",
          "type": "card",
          "email": "jsmith@example.com"
        }
      },
      "quote": {
        "amount": 2,
        "tax": 1,
        "total": 2,
        "address_required": true,
        "fee_minor": 1,
        "missing": [
          "<string>"
        ]
      },
      "redemption": {
        "code": "<string>",
        "amount_nanodollars": "<string>",
        "description": "<string>",
        "redeemed_at": "2023-11-07T05:31:56Z"
      },
      "scope": "workspace",
      "period": "total",
      "limit_nanodollars": 2,
      "requested_nanodollars": 2,
      "sign_in_method": "<string>",
      "masked_email": "<string>",
      "failure_reason": "<string>",
      "names": [
        "<string>"
      ],
      "fields": [
        "preferences.order"
      ],
      "volume_id": "<string>",
      "writer_sandbox_id": "<string>",
      "checkpoint": 2,
      "limit_bytes": 1,
      "observed_bytes": 1,
      "mismatch": {
        "field": "image",
        "recorded": "<string>",
        "requested": "<string>"
      },
      "volume_phase": "check",
      "phase": "code",
      "command": "<string>",
      "exit_code": 123,
      "stderr_tail": "<string>",
      "stdout_tail": "<string>",
      "agent": "<string>",
      "port": 32768,
      "revoked": true,
      "preview_id": "<string>",
      "url": "<string>"
    },
    "doc_url": "<string>",
    "fix": "<string>",
    "operation_id": "<string>",
    "provider": "<string>",
    "native_code": "<string>",
    "native_status": 123,
    "native_message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "outcome": "not_started",
    "retry": "safe",
    "retry_after_seconds": 1,
    "details": {
      "selection_version": 1,
      "considered": 1,
      "excluded": [
        {
          "provider": "<string>"
        }
      ],
      "closest": {},
      "nearest": [
        {}
      ],
      "requirement": "<string>",
      "purchase_id": "<string>",
      "preview": {
        "unused": 1,
        "held_excluded": 1,
        "fee": 1,
        "principal": 1,
        "tax": 1,
        "total": 1,
        "card": {
          "brand": "<string>",
          "last4": "<string>",
          "type": "card",
          "email": "jsmith@example.com"
        }
      },
      "quote": {
        "amount": 2,
        "tax": 1,
        "total": 2,
        "address_required": true,
        "fee_minor": 1,
        "missing": [
          "<string>"
        ]
      },
      "redemption": {
        "code": "<string>",
        "amount_nanodollars": "<string>",
        "description": "<string>",
        "redeemed_at": "2023-11-07T05:31:56Z"
      },
      "scope": "workspace",
      "period": "total",
      "limit_nanodollars": 2,
      "requested_nanodollars": 2,
      "sign_in_method": "<string>",
      "masked_email": "<string>",
      "failure_reason": "<string>",
      "names": [
        "<string>"
      ],
      "fields": [
        "preferences.order"
      ],
      "volume_id": "<string>",
      "writer_sandbox_id": "<string>",
      "checkpoint": 2,
      "limit_bytes": 1,
      "observed_bytes": 1,
      "mismatch": {
        "field": "image",
        "recorded": "<string>",
        "requested": "<string>"
      },
      "volume_phase": "check",
      "phase": "code",
      "command": "<string>",
      "exit_code": 123,
      "stderr_tail": "<string>",
      "stdout_tail": "<string>",
      "agent": "<string>",
      "port": 32768,
      "revoked": true,
      "preview_id": "<string>",
      "url": "<string>"
    },
    "doc_url": "<string>",
    "fix": "<string>",
    "operation_id": "<string>",
    "provider": "<string>",
    "native_code": "<string>",
    "native_status": 123,
    "native_message": "<string>"
  }
}

Credits and Billing

List Managed-Compute Credit Movements

Requires account-management permission; execution keys receive 403. Returns confirmed, nonzero charges from the configured test or live billing book, the later corrections to them, reservations still held, and reservations released with no charge, newest first. Results are limited to the calling workspace. BYOK work, supplier costs, provider account identities, API-key digests and raw usage evidence are not returned; a row’s key_id names the workspace API key it belongs to. A cursor belongs to this workspace and billing mode; invalid or foreign cursors return 400. New rows do not shift subsequent pages. No provider or payment-provider calls are made.

List managed-compute credit movements

curl --request GET \
  --url https://api.boxrouter.ai/api/v1/credits/usage \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.boxrouter.ai/api/v1/credits/usage', 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.boxrouter.ai/api/v1/credits/usage",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.boxrouter.ai/api/v1/credits/usage"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.boxrouter.ai/api/v1/credits/usage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "amount_nanodollars": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "kind": "sandbox_charge",
      "sandbox_id": "<string>",
      "sandbox_name": "<string>",
      "key_id": "<string>"
    }
  ],
  "next_cursor": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "outcome": "not_started",
    "retry": "safe",
    "retry_after_seconds": 1,
    "details": {
      "selection_version": 1,
      "considered": 1,
      "excluded": [
        {
          "provider": "<string>"
        }
      ],
      "closest": {},
      "nearest": [
        {}
      ],
      "requirement": "<string>",
      "purchase_id": "<string>",
      "preview": {
        "unused": 1,
        "held_excluded": 1,
        "fee": 1,
        "principal": 1,
        "tax": 1,
        "total": 1,
        "card": {
          "brand": "<string>",
          "last4": "<string>",
          "type": "card",
          "email": "jsmith@example.com"
        }
      },
      "quote": {
        "amount": 2,
        "tax": 1,
        "total": 2,
        "address_required": true,
        "fee_minor": 1,
        "missing": [
          "<string>"
        ]
      },
      "redemption": {
        "code": "<string>",
        "amount_nanodollars": "<string>",
        "description": "<string>",
        "redeemed_at": "2023-11-07T05:31:56Z"
      },
      "scope": "workspace",
      "period": "total",
      "limit_nanodollars": 2,
      "requested_nanodollars": 2,
      "sign_in_method": "<string>",
      "masked_email": "<string>",
      "failure_reason": "<string>",
      "names": [
        "<string>"
      ],
      "fields": [
        "preferences.order"
      ],
      "volume_id": "<string>",
      "writer_sandbox_id": "<string>",
      "checkpoint": 2,
      "limit_bytes": 1,
      "observed_bytes": 1,
      "mismatch": {
        "field": "image",
        "recorded": "<string>",
        "requested": "<string>"
      },
      "volume_phase": "check",
      "phase": "code",
      "command": "<string>",
      "exit_code": 123,
      "stderr_tail": "<string>",
      "stdout_tail": "<string>",
      "agent": "<string>",
      "port": 32768,
      "revoked": true,
      "preview_id": "<string>",
      "url": "<string>"
    },
    "doc_url": "<string>",
    "fix": "<string>",
    "operation_id": "<string>",
    "provider": "<string>",
    "native_code": "<string>",
    "native_status": 123,
    "native_message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "outcome": "not_started",
    "retry": "safe",
    "retry_after_seconds": 1,
    "details": {
      "selection_version": 1,
      "considered": 1,
      "excluded": [
        {
          "provider": "<string>"
        }
      ],
      "closest": {},
      "nearest": [
        {}
      ],
      "requirement": "<string>",
      "purchase_id": "<string>",
      "preview": {
        "unused": 1,
        "held_excluded": 1,
        "fee": 1,
        "principal": 1,
        "tax": 1,
        "total": 1,
        "card": {
          "brand": "<string>",
          "last4": "<string>",
          "type": "card",
          "email": "jsmith@example.com"
        }
      },
      "quote": {
        "amount": 2,
        "tax": 1,
        "total": 2,
        "address_required": true,
        "fee_minor": 1,
        "missing": [
          "<string>"
        ]
      },
      "redemption": {
        "code": "<string>",
        "amount_nanodollars": "<string>",
        "description": "<string>",
        "redeemed_at": "2023-11-07T05:31:56Z"
      },
      "scope": "workspace",
      "period": "total",
      "limit_nanodollars": 2,
      "requested_nanodollars": 2,
      "sign_in_method": "<string>",
      "masked_email": "<string>",
      "failure_reason": "<string>",
      "names": [
        "<string>"
      ],
      "fields": [
        "preferences.order"
      ],
      "volume_id": "<string>",
      "writer_sandbox_id": "<string>",
      "checkpoint": 2,
      "limit_bytes": 1,
      "observed_bytes": 1,
      "mismatch": {
        "field": "image",
        "recorded": "<string>",
        "requested": "<string>"
      },
      "volume_phase": "check",
      "phase": "code",
      "command": "<string>",
      "exit_code": 123,
      "stderr_tail": "<string>",
      "stdout_tail": "<string>",
      "agent": "<string>",
      "port": 32768,
      "revoked": true,
      "preview_id": "<string>",
      "url": "<string>"
    },
    "doc_url": "<string>",
    "fix": "<string>",
    "operation_id": "<string>",
    "provider": "<string>",
    "native_code": "<string>",
    "native_status": 123,
    "native_message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "outcome": "not_started",
    "retry": "safe",
    "retry_after_seconds": 1,
    "details": {
      "selection_version": 1,
      "considered": 1,
      "excluded": [
        {
          "provider": "<string>"
        }
      ],
      "closest": {},
      "nearest": [
        {}
      ],
      "requirement": "<string>",
      "purchase_id": "<string>",
      "preview": {
        "unused": 1,
        "held_excluded": 1,
        "fee": 1,
        "principal": 1,
        "tax": 1,
        "total": 1,
        "card": {
          "brand": "<string>",
          "last4": "<string>",
          "type": "card",
          "email": "jsmith@example.com"
        }
      },
      "quote": {
        "amount": 2,
        "tax": 1,
        "total": 2,
        "address_required": true,
        "fee_minor": 1,
        "missing": [
          "<string>"
        ]
      },
      "redemption": {
        "code": "<string>",
        "amount_nanodollars": "<string>",
        "description": "<string>",
        "redeemed_at": "2023-11-07T05:31:56Z"
      },
      "scope": "workspace",
      "period": "total",
      "limit_nanodollars": 2,
      "requested_nanodollars": 2,
      "sign_in_method": "<string>",
      "masked_email": "<string>",
      "failure_reason": "<string>",
      "names": [
        "<string>"
      ],
      "fields": [
        "preferences.order"
      ],
      "volume_id": "<string>",
      "writer_sandbox_id": "<string>",
      "checkpoint": 2,
      "limit_bytes": 1,
      "observed_bytes": 1,
      "mismatch": {
        "field": "image",
        "recorded": "<string>",
        "requested": "<string>"
      },
      "volume_phase": "check",
      "phase": "code",
      "command": "<string>",
      "exit_code": 123,
      "stderr_tail": "<string>",
      "stdout_tail": "<string>",
      "agent": "<string>",
      "port": 32768,
      "revoked": true,
      "preview_id": "<string>",
      "url": "<string>"
    },
    "doc_url": "<string>",
    "fix": "<string>",
    "operation_id": "<string>",
    "provider": "<string>",
    "native_code": "<string>",
    "native_status": 123,
    "native_message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "outcome": "not_started",
    "retry": "safe",
    "retry_after_seconds": 1,
    "details": {
      "selection_version": 1,
      "considered": 1,
      "excluded": [
        {
          "provider": "<string>"
        }
      ],
      "closest": {},
      "nearest": [
        {}
      ],
      "requirement": "<string>",
      "purchase_id": "<string>",
      "preview": {
        "unused": 1,
        "held_excluded": 1,
        "fee": 1,
        "principal": 1,
        "tax": 1,
        "total": 1,
        "card": {
          "brand": "<string>",
          "last4": "<string>",
          "type": "card",
          "email": "jsmith@example.com"
        }
      },
      "quote": {
        "amount": 2,
        "tax": 1,
        "total": 2,
        "address_required": true,
        "fee_minor": 1,
        "missing": [
          "<string>"
        ]
      },
      "redemption": {
        "code": "<string>",
        "amount_nanodollars": "<string>",
        "description": "<string>",
        "redeemed_at": "2023-11-07T05:31:56Z"
      },
      "scope": "workspace",
      "period": "total",
      "limit_nanodollars": 2,
      "requested_nanodollars": 2,
      "sign_in_method": "<string>",
      "masked_email": "<string>",
      "failure_reason": "<string>",
      "names": [
        "<string>"
      ],
      "fields": [
        "preferences.order"
      ],
      "volume_id": "<string>",
      "writer_sandbox_id": "<string>",
      "checkpoint": 2,
      "limit_bytes": 1,
      "observed_bytes": 1,
      "mismatch": {
        "field": "image",
        "recorded": "<string>",
        "requested": "<string>"
      },
      "volume_phase": "check",
      "phase": "code",
      "command": "<string>",
      "exit_code": 123,
      "stderr_tail": "<string>",
      "stdout_tail": "<string>",
      "agent": "<string>",
      "port": 32768,
      "revoked": true,
      "preview_id": "<string>",
      "url": "<string>"
    },
    "doc_url": "<string>",
    "fix": "<string>",
    "operation_id": "<string>",
    "provider": "<string>",
    "native_code": "<string>",
    "native_status": 123,
    "native_message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

BoxRouter API key; never an upstream provider key.

Query Parameters

limit

integer

default:20

Required range: 1 <= x <= 100

cursor

string

Required string length: 1 - 512

Response

Settled charge page; the amount is the credit debited, not provider cost.

data

object[]

required

Managed-compute credit movements, newest first. Settled nonzero charges, later corrections to them, reservations still held, and reservations released with no charge. BYOK work and internal cost evidence are excluded.

Show child attributes

next_cursor

string | null

required

Opaque workspace-scoped continuation cursor; null when no older charges remain.

Required string length: 1 - 512

Overview

Sandboxes

Commands

Processes

Files

Terminals

Previews

Volumes

Images

Operations

Routing Settings

Providers

Price Versions

Agent Catalog

Agent Launches

Launch Runs

Workspace Secrets

Artifacts

GitHub

GitHub Actions

Provider Accounts

Credits and Billing

Spend Limits

List Managed-Compute Credit Movements

Authorizations

Query Parameters

Response