Skip to main content
Get an inspection's payments
The Hive Inspect API is a work in progress. It is available to a small group of accounts today, and the release for everyone is coming very soon.

Authorizations

Authorization
string
header
required

Your API key from Business Tools → API Access.

Path Parameters

inspectionId
string<uuid>
required

Response

OK

inspection_id
string<uuid>
payment_status
string | null

Overall status, the same value as price.payment_status on the inspection.

paid
boolean

payment_status is paid.

settled
boolean

True only when the inspection is paid, nothing is owed by any payer, and no payment is still processing, awaiting closing or unknown. Use this before treating an inspection as fully paid.

has_refunds
boolean

At least one refund is pending or succeeded.

currency
string

usd or cad.

total
number | null

Services total across every payer, without the technology fee.

amount_paid
number | null

Services amount collected across every payer, after refunds.

amount_due
number | null

Services amount still owed across every payer.

invoice
object | null
shares
object[]
payments
object[]
refunds
object[]
failed_bank_payments
object[]