Schemas | Signals docs

BillingAccount

as_of

string · date-time · required

available_minor

integer · int64 · required

required

Calls refused since the hard stop began; not counted on this route yet, so always null.

capacity_minor

integer · int64 · required

required

When cash went below zero; not recorded yet, so always null.

cash_minor

integer · int64 · required

credit_limit_minor

integer · int64 · required

currency

string · required

required

Hours until available cash runs out at the current spend; not estimated yet, so always null.

exponent

integer · int32 · required

exposure_minor

integer · int64 · required

holds_minor

integer · int64 · required

id

string · required

live

boolean · required

required

The balance below which the account counts as low; not configurable yet, so always null.

BillingPromoPool[] · required

required

The code calls are refused with during a stop; not reported here yet, so always null.

required

When calls began to be refused; not reported here yet, so always null.

reserved_cash_minor

integer · int64 · required

required

How many live calls hold reserved cash; not counted yet, so always null.

revision

integer · int64 · required

state

BillingAccountState · enum · required

Enum values:

hard_stop_over_limit

unfunded

low_using_credit

promo_carrying

healthy

status

BillingAccountStatus · enum · required

Enum values:

active

suspended

closed

required

The suspension in force on the account; not reported yet, so always null.

required

The unpaid invoice holding the account; not reported yet, so always null.

BillingAccountState

string · enum

Enum values:

hard_stop_over_limit

unfunded

low_using_credit

promo_carrying

healthy

BillingAccountStatus

string · enum

Enum values:

active

suspended

closed

BillingDocumentCounts

credit_note

integer · int64 · min: 0 · required

invoice

integer · int64 · min: 0 · required

receipt

integer · int64 · min: 0 · required

statement

integer · int64 · min: 0 · required

BillingDocumentDetail

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: statement, kind
	type = object · requires: invoice, kind

Properties for Variant 1:

kind

string · enum · required

Enum values:

statement

BillingStatementDetail · required

BillingDocumentDownload

filename

string | null · required

format

BillingDocumentFormat · enum · required

Enum values:

csv

pdf

note

string | null · required

url

string | null · required

BillingDocumentFormat

string · enum

Enum values:

csv

pdf

BillingDocumentKind

string · enum

Enum values:

statement

invoice

credit_note

receipt

BillingDocumentLabelValue

label

string · required

value

string · required

BillingDocumentLink

href

string · required

label

string · required

BillingDocumentList

as_of

string · date-time · required

BillingDocumentCounts · required

currency

string · required

BillingDocumentRow[] · required

exponent

integer · int32 · required

invoiced

boolean · required

BillingDocumentParties

from

string · required

to

string · required

BillingDocumentRestriction

applied_at

string · date-time · required

code

string · required

BillingDocumentRow

detail

string | null · required

BillingDocumentDownload[] · required

id

string · required

issued_at

string | null · date-time · required

kind

BillingDocumentKind · enum · required

Enum values:

statement

invoice

credit_note

receipt

net_minor

integer | null · int64 · required

net_note

string | null · required

number

string | null · required

period_label

string | null · required

period_note

string | null · required

status

BillingDocumentStatus · enum · required

Enum values:

open

issued

paid

unpaid

applied

void

status_note

string | null · required

tax_minor

integer | null · int64 · required

title

string · required

total_minor

integer | null · int64 · required

BillingDocumentStatus

string · enum

Enum values:

open

issued

paid

unpaid

applied

void

BillingInvoiceDetail

detail

string | null · required

BillingDocumentDownload[] · required

id

string · required

issued_at

string | null · date-time · required

kind

BillingDocumentKind · enum · required

Enum values:

statement

invoice

credit_note

receipt

net_minor

integer | null · int64 · required

net_note

string | null · required

number

string | null · required

period_label

string | null · required

period_note

string | null · required

status

BillingDocumentStatus · enum · required

Enum values:

open

issued

paid

unpaid

applied

void

status_note

string | null · required

tax_minor

integer | null · int64 · required

title

string · required

total_minor

integer | null · int64 · required

BillingDocumentLabelValue[] · required

currency

string · required

exponent

integer · int32 · required

BillingDocumentLabelValue[] · required

BillingInvoiceLine[] · required

BillingDocumentParties · required

BillingDocumentLabelValue[] · required

BillingDocumentLink[] · required

required

tax_rule

string | null · required

usage_href

string | null · required

BillingInvoiceLine

amount_minor

integer · int64 · required

body

string · required

meta

string · required

ordinal

integer · int32 · required

quantity

string · required

title

string · required

unit_price_minor

integer · int64 · required

BillingPromoPool

amount_minor

integer · int64 · required

category

string · required

eligible_categories

array | null · required

expires_at

string · date-time · required

label

string · required

pool_id

string · required

reserved_minor

integer · int64 · required

reserved_sessions

integer | null · int64 · min: 0 · required

spent_at

string | null · date-time · required

BillingStatementDetail

detail

string | null · required

BillingDocumentDownload[] · required

id

string · required

issued_at

string | null · date-time · required

kind

BillingDocumentKind · enum · required

Enum values:

statement

invoice

credit_note

receipt

net_minor

integer | null · int64 · required

net_note

string | null · required

number

string | null · required

period_label

string | null · required

period_note

string | null · required

status

BillingDocumentStatus · enum · required

Enum values:

open

issued

paid

unpaid

applied

void

status_note

string | null · required

tax_minor

integer | null · int64 · required

title

string · required

total_minor

integer | null · int64 · required

BillingStatementSkuTotal[] · required

BillingStatementLine[] · required

closing_cash_minor

integer · int64 · required

currency

string · required

exponent

integer · int32 · required

line_count

integer · int32 · required

BillingStatementLine[] · required

opening_cash_minor

integer · int64 · required

reconcile_note

string · required

reconciles

boolean · required

BillingDocumentLink[] · required

treasury_revision

integer · int64 · required

version

integer · int64 · required

BillingStatementLine

amount_minor

integer · int64 · required

key

string · required

label

string · required

note

string | null · required

origin

string | null · required

sign

BillingStatementLineSign · enum · required

Enum values:

plus

minus

flat

sub

boolean · required

BillingStatementLineSign

string · enum

Enum values:

plus

minus

flat

BillingStatementSkuTotal

amount_minor

integer · int64 · required

detail

string · required

sku_code

string · required

CallSourceProduct

string · enum

Enum values:

trunking

voice

automation

NumberBlockConsumer

count

integer · int32 · min: 0 · required

id

string · required

name

string · required

type

string · required

Problem

The problem document every error response carries.

code

string · required

detail

string · required

request_id

string · required

status

integer · int32 · min: 0 · required

title

string · required

type

string · required

ProjectRef[]

caused_by

string

changed_resources

string[]

NumberBlockConsumer[]

expensive_filter

string

reason

string

remediation

string

ProjectRef

id

string · required

name

string · required

PromotionalCredit

applied_minor

integer · int64 · required

expires_at

string · date-time · required

remaining_minor

integer · int64 · required

RateCallerIdRule

restricts

boolean · required

text

string · required

RateCoverage

as_of

string · date-time · required

currency

string · required

effective_from

string · date-time · required

RateCoverageRow[] · required

RateCoverageGap

covered_until

string | null · date-time · required

missing

RateCoverageGapKind · enum · required

Enum values:

route

rate

both

RateCoverageNeighbour[] · required

prefix

string · required

rate_micro

integer | null · int64 · required

reason

string | null · required

RateCoverageGapKind

string · enum

Enum values:

route

rate

both

RateCoverageNeighbour

name

string · required

prefix

string · required

RateCoverageRow

also_prefixes

string[] · required

available_since

string · date-time · required

RateCallerIdRule · required

connection_fee_minor

integer · int64 · required

country

string · required

country_code

string · required

id

string · required

RateIncrement · required

name

string · required

prefix

string · required

rate_micro

integer · int64 · required

route_class

string · required

RateDestination

also_prefixes

string[] · required

country

string · required

country_code

string · required

name

string · required

prefix

string · required

RateDirection

string · enum

Enum values:

inbound

outbound

RateIncrement

increment_seconds

integer · int32 · required

minimum_seconds

integer · int32 · required

plan_name

string | null · required

RateLookup

as_of

string · date-time · required

containment

string | null · required

covered

boolean · required

currency

string · required

required

destination_number

string · required

direction

RateDirection · enum · required

Enum values:

inbound

outbound

required

RatePriceBook · required

required

RatePriceBook

id

string · required

name

string · required

RateTerms

RateCallerIdRule · required

connection_fee_minor

integer · int64 · required

effective_from

string · date-time · required

RateIncrement · required

rate_micro

integer · int64 · required

route_class

string · required

UpcomingRateTerms

RateCallerIdRule · required

connection_fee_minor

integer · int64 · required

effective_from

string · date-time · required

RateIncrement · required

rate_micro

integer · int64 · required

route_class

string · required

notice_days

integer · int64 · required

published_at

string · date-time · required

UsageAmounts

calls_minor

integer · int64 · required

numbers_minor

integer · int64 · required

promotional_credit_minor

integer · int64 · required

recording_minor

integer · int64 · required

settling_minor

integer · int64 · required

total_minor

integer · int64 · required

voice_minor

integer · int64 · required

UsageDay

UsageProductAmount[] · required

date

string · date · required

partial

boolean · required

total_minor

integer · int64 · required

UsageDimension

string · enum

Enum values:

day

product

trunk

subaccount

destination

number_block

UsageProductAmount

amount_minor

integer · int64 · required

product

CallSourceProduct · enum · required

Enum values:

trunking

voice

automation

UsageQuantity

billable_seconds

integer · int64 · min: 0 · required

calls

integer · int64 · min: 0 · required

numbers

integer · int64 · min: 0 · required

observed_seconds

integer · int64 · min: 0 · required

recorded_seconds

integer · int64 · min: 0 · required

UsageRate

atoms_per_unit

integer · int64 · required

connection_fee_minor

integer | null · int64 · required

offer_id

string · required

price_id

string | null · uuid · required

quantity_increment_atoms

integer · int64 · required

quantity_minimum_atoms

integer · int64 · required

sku_code

string · required

unit

string · required

unit_price_minor

integer · int64 · required

UsageRow

UsageAmounts · required

detail

string | null · required

dimension

UsageDimension · enum · required

Enum values:

day

product

trunk

subaccount

destination

number_block

UsageScope

id

string · required

name

string · required

UsageScopes

UsageScope[] · required

UsageState

text

string · required

tone

string · required

UsageSummary

as_of

string · date-time · required

UsageProductAmount[] · required

currency

string · required

UsageDay[] · required

dimension

UsageDimension · enum · required

Enum values:

day

product

trunk

subaccount

destination

number_block

UsageWindow

days

integer · int32 · min: 0 · required

from

string · date · required

partial

boolean · required

to

string · date · required