Get Job Run Cost Summary

curl --request GET \
  --url https://api.dispersed.com/v1/job-runs/{uuid}/cost-summary

const options = {method: 'GET'};

fetch('https://api.dispersed.com/v1/job-runs/{uuid}/cost-summary', 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.dispersed.com/v1/job-runs/{uuid}/cost-summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.dispersed.com/v1/job-runs/{uuid}/cost-summary"

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

	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.dispersed.com/v1/job-runs/{uuid}/cost-summary")

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

request = Net::HTTP::Get.new(url)

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

{
  "gross_spend": 123,
  "refunds": 123,
  "net_spend": 123,
  "prep_spend": 123,
  "exec_spend": 123,
  "unattributed_spend": 123,
  "pending_hold": 123,
  "calculated_cost": 123,
  "transaction_count": 123,
  "billing_rule": "ONE_TIME",
  "hourly_rate_usd": 123,
  "currency": "EUR",
  "transactions": [
    {
      "amount_usd": 123,
      "type": "CAPTURE",
      "object": "compute_ledger_transaction",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "uuid": "<string>",
      "calculation_snapshot": {
        "amount": 123,
        "billing_phase": "PREPARATION",
        "calculation_version": "compute-ledger-capture/v1",
        "computed_at": "2023-11-07T05:31:56Z",
        "currency": "EUR",
        "execution_duration_ms": 123,
        "inferred": true,
        "minimum_amount": 123,
        "preparation_duration_ms": 123,
        "rate": 123,
        "rate_currency": "EUR",
        "rounding_mode": "half-even",
        "rounding_scale": 123,
        "source": "live_capture"
      },
      "job_run_uuid": "<string>",
      "authorization_uuid": "<string>",
      "consumer_profile_uuid": "<string>",
      "consumer_account_uuid": "<string>",
      "render_user_id": "<string>",
      "render_credit_id": "<string>",
      "memo": "<string>"
    }
  ],
  "authorization": {
    "amount_usd": 123,
    "approved": true,
    "status": "CLOSED",
    "opened_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "object": "compute_ledger_authorization",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "uuid": "<string>",
    "calculation_snapshot": {
      "amount": 123,
      "billing_phase": "PREPARATION",
      "calculation_version": "compute-ledger-authorization/v1",
      "computed_at": "2023-11-07T05:31:56Z",
      "currency": "EUR",
      "execution_duration_ms": 123,
      "minimum_amount": 123,
      "preparation_duration_ms": 123,
      "rate": 123,
      "rate_currency": "EUR",
      "rounding_mode": "half-even",
      "rounding_scale": 123,
      "source": "assignment_hold",
      "network_pricing_policy_uuid": "<string>"
    },
    "billing_phase": "PREPARATION",
    "status_reason": "<string>",
    "closed_at": "2023-11-07T05:31:56Z",
    "consumer_account_uuid": "<string>",
    "consumer_profile_uuid": "<string>",
    "job_run_uuid": "<string>",
    "render_user_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

GET

job-runs

{uuid}

cost-summary

Get Job Run Cost Summary

curl --request GET \
  --url https://api.dispersed.com/v1/job-runs/{uuid}/cost-summary

const options = {method: 'GET'};

fetch('https://api.dispersed.com/v1/job-runs/{uuid}/cost-summary', 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.dispersed.com/v1/job-runs/{uuid}/cost-summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.dispersed.com/v1/job-runs/{uuid}/cost-summary"

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

	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.dispersed.com/v1/job-runs/{uuid}/cost-summary")

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

request = Net::HTTP::Get.new(url)

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

{
  "gross_spend": 123,
  "refunds": 123,
  "net_spend": 123,
  "prep_spend": 123,
  "exec_spend": 123,
  "unattributed_spend": 123,
  "pending_hold": 123,
  "calculated_cost": 123,
  "transaction_count": 123,
  "billing_rule": "ONE_TIME",
  "hourly_rate_usd": 123,
  "currency": "EUR",
  "transactions": [
    {
      "amount_usd": 123,
      "type": "CAPTURE",
      "object": "compute_ledger_transaction",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "uuid": "<string>",
      "calculation_snapshot": {
        "amount": 123,
        "billing_phase": "PREPARATION",
        "calculation_version": "compute-ledger-capture/v1",
        "computed_at": "2023-11-07T05:31:56Z",
        "currency": "EUR",
        "execution_duration_ms": 123,
        "inferred": true,
        "minimum_amount": 123,
        "preparation_duration_ms": 123,
        "rate": 123,
        "rate_currency": "EUR",
        "rounding_mode": "half-even",
        "rounding_scale": 123,
        "source": "live_capture"
      },
      "job_run_uuid": "<string>",
      "authorization_uuid": "<string>",
      "consumer_profile_uuid": "<string>",
      "consumer_account_uuid": "<string>",
      "render_user_id": "<string>",
      "render_credit_id": "<string>",
      "memo": "<string>"
    }
  ],
  "authorization": {
    "amount_usd": 123,
    "approved": true,
    "status": "CLOSED",
    "opened_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "object": "compute_ledger_authorization",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "uuid": "<string>",
    "calculation_snapshot": {
      "amount": 123,
      "billing_phase": "PREPARATION",
      "calculation_version": "compute-ledger-authorization/v1",
      "computed_at": "2023-11-07T05:31:56Z",
      "currency": "EUR",
      "execution_duration_ms": 123,
      "minimum_amount": 123,
      "preparation_duration_ms": 123,
      "rate": 123,
      "rate_currency": "EUR",
      "rounding_mode": "half-even",
      "rounding_scale": 123,
      "source": "assignment_hold",
      "network_pricing_policy_uuid": "<string>"
    },
    "billing_phase": "PREPARATION",
    "status_reason": "<string>",
    "closed_at": "2023-11-07T05:31:56Z",
    "consumer_account_uuid": "<string>",
    "consumer_profile_uuid": "<string>",
    "job_run_uuid": "<string>",
    "render_user_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

Path Parameters

uuid

string<uuid>

required

Response

Job run cost summary retrieved successfully

gross_spend

number | null

required

Total spend amount (sum of all captures)

refunds

number | null

required

Total refund amount

net_spend

number | null

required

Net spend (gross_spend - refunds)

prep_spend

number | null

required

Net spend attributed to the preparation phase via each transaction's authorization billing_phase. Legacy transactions without phase tagging count only toward the overall totals.

exec_spend

number | null

required

Net spend attributed to the execution phase via each transaction's authorization billing_phase. Legacy transactions without phase tagging count only toward the overall totals.

unattributed_spend

number | null

required

Net spend not attributable to a billing phase: legacy transactions without phase tagging, plus any phase deficit from asymmetric refund attribution. Floored at zero.

pending_hold

number | null

required

Sum of all open authorization holds — PREP and EXEC holds can be open simultaneously during preparation (0 if none)

calculated_cost

number | null

required

Calculated cost based on hourly_rate × duration

transaction_count

integer

required

Number of transactions for this job run

billing_rule

enum<string>

required

Billing rule applied to this job run

Available options:

ONE_TIME,

HOURLY,

EXEMPT

hourly_rate_usd

number

required

Hourly rate in USD

currency

enum<string>

required

Available options:

EUR

transactions

object[]

required

List of billing transactions for this job run

Show child attributes

authorization

object

required

Active or most recent authorization for this job run

Show child attributes

Account Agreements

Accounts

Agreements

API Keys

Compute

Compute Rewards

Compute Ledger

Consumer Profiles

GPU Registry

Job Recipes

Job Runs

Jobs

Nodes

Node Sessions

Operator Profiles

SSH Public Keys

Users

Get Job Run Cost Summary

Path Parameters

Response