Schemas
AppId
domainchief Domain Chief. |
certchief Cert Chief. |
deploychief Deploy Chief. |
tny Tny. |
flowguard FlowGuard. |
backupchief Backup Chief. |
socketchief Socket Chief. |
billdo Bill.DO. |
Team
slugIdentifier of the team.
nameDisplay name of the team.
avatarURL of the team avatar.
timezoneIANA timezone used by the team.
avatar_hashVersion identifier for the current avatar.
gravatar_emailEmail address used to resolve the team's Gravatar.
Teams whose billing is linked to this team.
TeamConnectedApp
idApplication identifier.
nameApplication display name.
Effective limits combined with usage reported by this team.
TeamConnectedAppLimit
idLimit identifier.
unitUnit counted by this limit.
limitMaximum allowed usage, or null when usage is unlimited.
unlimitedIndicates whether usage is unlimited.
usageUsage reported by the requested team, or null when the application does not report usage.
TeamConnectedAppPlan
idPlan identifier.
namePlan display name.
is_freeIndicates whether the plan has no recurring price.
TeamInviteMemberRequest
emailEmail address to invite to the team.
roleRole assigned after acceptance.
accessible_app_idsApplication IDs this member can access. Null grants all team applications.
TeamInvoice
idInvoice identifier.
numberHuman-readable invoice number, or null before one is assigned.
appApplication that issued the invoice.
statusCurrent 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_dateDate and time the invoice was issued.
totalTotal in the invoice currency's minor unit.
currencyISO 4217 currency code used for monetary amounts.
EUR Euro. |
USD United States dollar. |
Invoice line items when expanded, otherwise null.
line_countNumber of line items on the invoice.
memoOptional note attached to the invoice.
payment_pendingIndicates whether payment processing is still pending.
hosted_urlProvider-hosted page for viewing or paying the invoice.
pdf_urlTemporary invoice PDF URL valid for one hour.
TeamInvoiceLine
idInvoice line identifier assigned by the source application.
source_teamTeam that generated the line.
descriptionHuman-readable line description.
amountAmount in the invoice currency's minor unit.
categoryOptional category assigned by the source application.
resourceResource billed by this line, when supplied by the source application.
period_startStart of the billing period covered by this line.
period_endEnd of the billing period covered by this line.
TeamInvoiceStatus
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
idUser identifier.
nameUser display name.
roleCurrent membership role.
accessible_app_idsApplication IDs this member can access. Null grants all team applications.
emailUser email address.
avatarURL of the user's avatar.
joined_atDate and time the user joined the team.
TeamReference
slugIdentifier of the team.
nameDisplay name of the team.
TeamToken
idToken identifier.
nameToken display name.
scopesPermissions granted to the token.
creatorUser who created the token, or null when unavailable.
created_atDate and time the token was created.
last_used_atDate and time the token was last used.
expires_atDate and time the token expires, or null when it does not expire.
TeamUpdateMemberRoleRequest
roleNew membership role.
accessible_app_idsApplication IDs this member can access. Null grants all team applications.
TeamUpdateRequest
nameTeam display name.
timezoneIANA timezone used by the team.
gravatar_emailEmail address used to resolve the team's Gravatar.