Billing

Gets the total amount the organization currently owes, broken down by unpaid invoices and periods awaiting an invoice.

Changed on

The total covers finalized-but-unpaid invoices plus the settled amount of ended periods not yet invoiced; the current, still-accruing period is reported separately and is not part of the total. The awaiting-invoice figure comes from settlement snapshots and may move while settlementStale is set.

get/billing/outstanding

Request

  • Base URL
    https://api.rapidata.ai
  • URL
    https://api.rapidata.ai/billing/outstanding
  • Auth
    OpenID Connect (https://auth.rapidata.ai/.well-known/openid-configuration, scopes: openid, profile, email, offline_access, api)

Query parameters

organizationIdstring

The organization to get the outstanding cost for. Defaults to the caller's own organization.

Response

OK

totalOutstandingnumber double required

The total the organization currently owes: unpaid invoices plus periods awaiting an invoice. Excludes the current, still-accruing period.

unpaidInvoicesAmountnumber double required

The amount owed on finalized invoices that have not been paid.

unpaidInvoiceCountinteger required

How many unpaid invoices make up UnpaidInvoicesAmount.

awaitingInvoiceAmountnumber double required

The settled amount of ended periods that have not been invoiced yet.

awaitingInvoicePeriodCountinteger required

How many periods make up AwaitingInvoiceAmount.

currentPeriodAccruednumber double required

Billable spend accrued in the current, still-open period. Not part of TotalOutstanding: nothing is due until the period ends and settles.

currencystring nullable

The currency the amounts are denominated in, or null when nothing is outstanding.

settlementStaleboolean required

Whether any period behind AwaitingInvoiceAmount is awaiting a settlement recompute, so that figure may still change.

Changes