Skip to content
Nodus
Blog

getBillingAccount

GET
/apis/nodus.dev/v1/billingaccounts/default
 
curl --request GET \
  --url https://example.com/apis/nodus.dev/v1/billingaccounts/default

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

The organization’s billing account.

Media type application/json
object
status
object
liquidCapacity

LiquidBillingSummary reports settled ledger activity in the current UTC calendar month. Earned credits do not expire at the period boundary. Applications are posted spending, never pending funding holds.

object
appliedToOtherChargesUSD
required

AppliedToOtherChargesUSD is earned credit captured for other eligible charges, net of corrections.

string
appliedToReservationsUSD
required

AppliedToReservationsUSD is earned credit captured for reservation charges, net of corrections.

string
baseReservationChargesUSD
required

BaseReservationChargesUSD is posted base reservation usage, including signed charge corrections.

string
earnedCreditsUSD
required

EarnedCreditsUSD is lending compensation posted during this reporting period.

string
earningsCorrectionsUSD
required

EarningsCorrectionsUSD is the signed adjustment to lending earnings posted during this period.

string
netEarnedCreditsUSD
required

NetEarnedCreditsUSD is EarnedCreditsUSD plus EarningsCorrectionsUSD.

string
netReservationChargesUSD
required

NetReservationChargesUSD is base reservation charges less earned credits actually applied to them.

string
periodEndTime
required

PeriodEndTime is the exclusive end of the current UTC calendar month.

string
periodStartTime
required

PeriodStartTime is the inclusive start of the current UTC calendar month.

string
remainingEarnedBalanceUSD
required

RemainingEarnedBalanceUSD is unspent earned credit, including carryover and amounts currently held.

string
reservationCoveredBasisPoints

ReservationCoveredBasisPoints is omitted when net monthly charges cannot define a percentage.

integer format: int64
reservedEarnedBalanceUSD
required

ReservedEarnedBalanceUSD is held for work but has not yet paid a charge.

string
key
additional properties
any
key
additional properties
any
Example generated 
{
  "status": {
    "liquidCapacity": {
      "appliedToOtherChargesUSD": "example",
      "appliedToReservationsUSD": "example",
      "baseReservationChargesUSD": "example",
      "earnedCreditsUSD": "example",
      "earningsCorrectionsUSD": "example",
      "netEarnedCreditsUSD": "example",
      "netReservationChargesUSD": "example",
      "periodEndTime": "example",
      "periodStartTime": "example",
      "remainingEarnedBalanceUSD": "example",
      "reservationCoveredBasisPoints": 1,
      "reservedEarnedBalanceUSD": "example"
    }
  }
}

default

Section titled “ default ”

An error: a metav1.Status whose reason is a registered code.

Media type application/json

Status is the error body of every API response: a Kubernetes metav1.Status (so kubectl and client-go understand it) plus three top-level extensions that those clients ignore (ADR-028).

object
apiVersion
string
code
integer format: int32
details
object
causes
Array<object>
nullable
object
field
string
message
string
reason
string
group
string
kind
string
name
string
retryAfterSeconds
integer format: int32
uid
string
docs

Docs is the URL of the code’s docs page.

string
fix

Fix says what to do next, for example a CLI command or the field to change.

string
kind
string
message
string
metadata
object
continue
string
remainingItemCount
integer format: int64
resourceVersion
string
selfLink
string
shardInfo
object
selector
required
string
reason
string
requestId

RequestID identifies the request in logs and support tickets.

string
status
string
Example generated 
{
  "apiVersion": "example",
  "code": 1,
  "details": {
    "causes": [
      {
        "field": "example",
        "message": "example",
        "reason": "example"
      }
    ],
    "group": "example",
    "kind": "example",
    "name": "example",
    "retryAfterSeconds": 1,
    "uid": "example"
  },
  "docs": "example",
  "fix": "example",
  "kind": "example",
  "message": "example",
  "metadata": {
    "continue": "example",
    "remainingItemCount": 1,
    "resourceVersion": "example",
    "selfLink": "example",
    "shardInfo": {
      "selector": "example"
    }
  },
  "reason": "example",
  "requestId": "example",
  "status": "example"
}