Schemas

AppId

string


`domainchief` Domain Chief.
`certchief` Cert Chief.
`deploychief` Deploy Chief.
`tny` Tny.
`flowguard` FlowGuard.
`backupchief` Backup Chief.
`socketchief` Socket Chief.
`serverchief` Server Chief.
`billdo` Bill.DO.

Team

slug

string · required

Identifier of the team.

name

string · required

Display name of the team.

required

avatar

string · required

URL of the team avatar.

timezone

string · required

IANA timezone used by the team.

avatar_hash

string | null · required

Version identifier for the current avatar.

gravatar_email

string | null · required

Email address used to resolve the team's Gravatar.

TeamReference[]

Teams whose billing is linked to this team.

TeamBillingCurrency

string


`EUR` Euro.
`USD` United States dollar.

TeamConnectedApp

id

string · required

Application identifier.

name

string · required

Application display name.

required

TeamConnectedAppLimit[] · required

Effective limits combined with usage reported by this team.

TeamConnectedAppLimit

id

string · required

Limit identifier.

unit

string | null · required

Unit counted by this limit.

limit

integer | null · required

Maximum allowed usage, or null when usage is unlimited.

unlimited

boolean · required

Indicates whether usage is unlimited.

usage

integer | null · required

Usage reported by the requested team, or null when the application does not report usage.

TeamConnectedAppPlan

id

string · required

Plan identifier.

name

string · required

Plan display name.

is_free

boolean · required

Indicates whether the plan has no recurring price.

TeamInviteMemberRequest

email

string · email · required

Email address to invite to the team.

role

string | null · enum

Role assigned after acceptance.

Enum values:

owner

member

billing

accessible_app_ids

array | null · unique

Application IDs this member can access. Null grants all team applications.

Enum values:

domainchief

certchief

tny

deploychief

backupchief

flowguard

socketchief

serverchief

TeamInvoice

id

string · required

Invoice identifier.

number

string | null · required

Human-readable invoice number, or null before one is assigned.

app

object | null · required

Application that issued the invoice.

status

TeamInvoiceStatus · required

Current invoice status.


`draft` The invoice is still being prepared and cannot be paid yet.
`open` The invoice is finalized and awaiting payment.
`pending` Payment processing has started but has not completed.
`paid` The invoice has been paid.
`uncollectible` The invoice is unlikely to be paid and has been marked uncollectible.
`void` The invoice was cancelled.

invoice_date

string | null · date-time · required

Date and time the invoice was issued.

total

integer · required

Total in the invoice currency's minor unit.

currency

TeamBillingCurrency · required

ISO 4217 currency code used for monetary amounts.


`EUR` Euro.
`USD` United States dollar.

array | null · required

Invoice line items when expanded, otherwise null.

line_count

integer

Number of line items on the invoice.

memo

string | null

Optional note attached to the invoice.

payment_pending

boolean

Indicates whether payment processing is still pending.

hosted_url

string | null

Provider-hosted page for viewing or paying the invoice.

pdf_url

string | null

Temporary invoice PDF URL valid for one hour.

TeamInvoiceLine

id

string · required

Invoice line identifier assigned by the source application.

source_team

object | null · required

Team that generated the line.

description

string · required

Human-readable line description.

amount

integer · required

Amount in the invoice currency's minor unit.

category

object | null · required

Optional category assigned by the source application.

resource

object | null · required

Resource billed by this line, when supplied by the source application.

period_start

string | null · date-time · required

Start of the billing period covered by this line.

period_end

string | null · date-time · required

End of the billing period covered by this line.

TeamInvoiceStatus

string


`draft` The invoice is still being prepared and cannot be paid yet.
`open` The invoice is finalized and awaiting payment.
`pending` Payment processing has started but has not completed.
`paid` The invoice has been paid.
`uncollectible` The invoice is unlikely to be paid and has been marked uncollectible.
`void` The invoice was cancelled.

TeamMember

id

string · required

User identifier.

name

string · required

User display name.

role

TeamMembershipRole · required

Current membership role.

accessible_app_ids

array | null · required

Application IDs this member can access. Null grants all team applications.

email

string · required

User email address.

avatar

string · required

URL of the user's avatar.

joined_at

string | null · date-time · required

Date and time the user joined the team.

TeamMembershipRole

string

TeamReference

slug

string · required

Identifier of the team.

name

string · required

Display name of the team.

TeamToken

id

string · required

Token identifier.

name

string · required

Token display name.

scopes

string[] · required

Permissions granted to the token.

object[] · required

The resources the token is restricted to, as RFC 9396 authorization details. Empty when the token can access every resource.

creator

object | null · required

User who created the token, or null when unavailable.

created_at

string · date-time · required

Date and time the token was created.

last_used_at

string | null · date-time · required

Date and time the token was last used.

expires_at

string | null · date-time · required

Date and time the token expires, or null when it does not expire.

TeamUpdateMemberRoleRequest

role

string · enum

New membership role.

Enum values:

owner

member

billing

accessible_app_ids

array | null · unique

Application IDs this member can access. Null grants all team applications.

Enum values:

domainchief

certchief

tny

deploychief

backupchief

flowguard

socketchief

serverchief

TeamUpdateRequest

name

string · minLength: 1 · maxLength: 255

Team display name.

timezone

string | null · enum

IANA timezone used by the team.

Enum values:

Africa/Abidjan

Africa/Accra

Africa/Addis_Ababa

Africa/Algiers

Africa/Asmara

Africa/Bamako

Africa/Bangui

Africa/Banjul

gravatar_email

string | null · email

Email address used to resolve the team's Gravatar.