---
title: "billing.credit-hold-settle-result@1 · OpenVibe.Services"
canonical: "https://openvibe.services/docs/contracts/billing.credit-hold-settle-result"
updated: null
---

# billing.credit-hold-settle-result@1 · OpenVibe.Services

HTML: [billing.credit-hold-settle-result@1 · OpenVibe.Services](https://openvibe.services/docs/contracts/billing.credit-hold-settle-result)

# BillingCreditHoldSettleResult `billing.credit-hold-settle-result@1`

Generated at 2026-11-13 06:25:48 UTC from [`openvibe-contracts v0.419.0`](https://github.com/OpenVibers/OpenVibe.Contracts/tree/v0.419.0) and [`openvibe-sdk v0.161.0`](https://github.com/OpenVibers/OpenVibe.SDK/tree/v0.161.0).

- Version: 1.0.0
- Owner: billing
- Visibility: internal
- Status: active
- Compatibility: backward
- Schema: [`https://openvibe.network/contracts/billing/credit-hold-settle-result.v1.json`](/docs/contracts/billing.credit-hold-settle-result.json)

billing.credit-hold-settle-result@1: response from POST /internal/credits/holds/:id/settle.

## Fields

| Field | Type | Required | Description | Constraints |
| --- | --- | --- | --- | --- |
| `charge_nano_usd` | `https://openvibe.network/contracts/billing/credit-hold-settle-result.v1.json#/$defs/money-nano-usd` | yes |  |  |
| `released_nano_usd` | `https://openvibe.network/contracts/billing/credit-hold-settle-result.v1.json#/$defs/money-nano-usd` | yes |  |  |
| `journal_id` | string | yes |  | - `pattern ^txn_` |
| `shortfall_nano_usd` | string |  | Usage beyond the hold and the free balance: owed, not collected (nano-USD, D1). | - `pattern ^[0-9]{1,19}$` |

## Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

 Valid: full

~~~~
{
  "charge_nano_usd": "18000",
  "released_nano_usd": "82000000",
  "journal_id": "txn_01JAB2C3D4E5F6G7H8J9K0MNPQ"
}
~~~~

Valid: zero

~~~~
{
  "charge_nano_usd": "0",
  "released_nano_usd": "50000000",
  "journal_id": "txn_01JAB2C3D4E5F6G7H8J9K0MNPR"
}
~~~~

Rejected: missing-journal

~~~~
{
  "charge_nano_usd": "18000",
  "released_nano_usd": "82000000"
}
~~~~

Rejected: money-float

~~~~
{
  "charge_nano_usd": "18.5",
  "released_nano_usd": "82000000",
  "journal_id": "txn_01JAB2C3D4E5F6G7H8J9K0MNPQ"
}
~~~~

Rejected: money-number

~~~~
{
  "charge_nano_usd": 18000,
  "released_nano_usd": "82000000",
  "journal_id": "txn_01JAB2C3D4E5F6G7H8J9K0MNPQ"
}
~~~~

## Validate

~~~~
const contracts = require('openvibe-contracts');
contracts.validate('billing.credit-hold-settle-result@1', value);   // { valid, errors: [{ path, message }] }
~~~~