End budgeted run - Unprice Documentation

// Close only after billable usage is accounted for, or no billable work occurred.
const { result, error } = await unprice.runs.end({
  runId: "brun_123",
  status: "completed"
});

if (error) {
  console.error(error.message);
  return;
}

console.log(result.status);

{
  "runId": "brun_123",
  "status": "completed",
  "customerId": "cus_1234567890",
  "budgetAmountMinor": 5000,
  "consumedAmountMinor": 1200,
  "remainingAmountMinor": 3800,
  "currency": "USD",
  "workloadType": "workflow",
  "workloadId": "wf_summary_123",
  "traceId": "trace_123",
  "parentRunId": null
}

// Close only after billable usage is accounted for, or no billable work occurred.
const { result, error } = await unprice.runs.end({
  runId: "brun_123",
  status: "completed"
});

if (error) {
  console.error(error.message);
  return;
}

console.log(result.status);

{
  "runId": "brun_123",
  "status": "completed",
  "customerId": "cus_1234567890",
  "budgetAmountMinor": 5000,
  "consumedAmountMinor": 1200,
  "remainingAmountMinor": 3800,
  "currency": "USD",
  "workloadType": "workflow",
  "workloadId": "wf_summary_123",
  "traceId": "trace_123",
  "parentRunId": null
}

Use runs.end when the workload finishes. Ending the run releases unused reservation funds and locks the final run status.

The reservations helper already calls this from reservation.settle() and reservation.release(). Call runs.end yourself only when you drive the run through the runs operations directly.

// Close only after billable usage is accounted for, or no billable work occurred.
const { result, error } = await unprice.runs.end({
  runId: "brun_123",
  status: "completed"
});

if (error) {
  console.error(error.message);
  return;
}

console.log(result.status);

{
  "runId": "brun_123",
  "status": "completed",
  "customerId": "cus_1234567890",
  "budgetAmountMinor": 5000,
  "consumedAmountMinor": 1200,
  "remainingAmountMinor": 3800,
  "currency": "USD",
  "workloadType": "workflow",
  "workloadId": "wf_summary_123",
  "traceId": "trace_123",
  "parentRunId": null
}

Request

string

required

The budgeted run ID.

"completed" | "canceled" | "failed"

Final status for the run. Defaults to completed.

Response

Returns the final budget run summary after unused reservation funds are released. If provider work has completed but settlement is unconfirmed, retry runs.settle with the same idempotency key. Do not release the funds as error cleanup while that usage still needs accounting.

​Request

​Response

Request

Response