CustomerUnit

A team, workspace or tenant in a customer's tree of units.

billable
Type: boolean
required

The unit's own billable setting.
createdAt
Type: stringFormat: date-time
required

When the unit was created.
customerExternalId
Type: string | null
required

Your ID for the customer.
customerId
Type: string
required

The customer the unit belongs to (cus_…).
effectiveBillable
Type: boolean
required

Whether usage from this unit is billed: true only when this unit and every unit above it are billable.
externalId
Type: string
required

The unit's key.
externalType
Type: string | null
required

Your own kind for the unit.
isRoot
Type: boolean
required

Whether this is the top of the customer's tree.
metadata
Type: nullable
required

Your own key-value data, or null.

Properties: 1
name
Type: string
required

Display name.
parentExternalId
Type: string | null
required

Key of the parent unit, or null for the root.
status
Type: "ACTIVE" or "DELETED"enum
required

ACTIVE, or DELETED once deleted.
updatedAt
Type: stringFormat: date-time
required

When the unit was last changed.
id
Type: string

Spondo Billing ID of the unit (cu_…). Returned by the routes under /customers; the routes under /customer-units address units by key and leave it out.