Organizations

Create Organization

client.organizations.create(, ?): Organization { id, billing_email, billing_state, 11 more }

POST/v1/organizations

Get Organization Details

client.organizations.get(, ?): Organization { id, billing_email, billing_state, 11 more }

GET/v1/organizations/{organization_id}

Update Organization

client.organizations.update(, , ?): Organization { id, billing_email, billing_state, 11 more }

PATCH/v1/organizations/{organization_id}

List Organizations

client.organizations.list(?, ?): Cursor<Organization { id, billing_email, billing_state, 11 more } >

GET/v1/organizations

Leave Organization

client.organizations.leave(, ?): void

POST/v1/organizations/{organization_id}/leave

ModelsExpand Collapse

Organization { id, billing_email, billing_state, 11 more }

Organization response.

id: string

Organization ID.

billing_email: string | null

Billing email. Null when no custom billing email is set (reverts to the oldest owner’s email).

billing_state: "unfunded" | "active" | "requires_action" | 2 more

Organization billing lifecycle state.

One of the following:

"unfunded"

"active"

"requires_action"

"suspended"

"closed"

billing_state_since: string

When the organization entered its current billing state.

formatdate-time

charging_model: "manual" | "prepaid"

How the organization is charged for resource usage.

One of the following:

"manual"

"prepaid"

created_at: string

When the Organization was created.

formatdate-time

domains: Array<OrganizationDomain { id, domain, verified } >

Domains associated with the organization.

id: string

Domain ID.

domain: string

Domain name.

verified: boolean

Whether the domain has been verified.

name: string

Organization name.

personal: boolean

Whether the organization is a personal Organization.

services: OrganizationServices { cloud, jit_provisioning, scim, 2 more }

Services that the Organization has access to.

cloud: boolean

Whether cloud services are enabled for the organization.

jit_provisioning: boolean

Whether just-in-time provisioning is enabled for the organization.

scim: boolean

Whether SCIM provisioning is enabled for the organization.

siem: boolean

Whether SIEM integration is enabled for the organization.

sso: boolean

Whether single sign-on is enabled for the organization.

stripe_customer_id: string | null

Stripe customer ID.

type: OrganizationType

Organization type.

One of the following:

"personal"

"company"

updated_at: string

When the Organization was updated.

formatdate-time

auth_id?: string

Authentication provider organization ID.

OrganizationDomain { id, domain, verified }

Organization domain details.

id: string

Domain ID.

domain: string

Domain name.

verified: boolean

Whether the domain has been verified.

OrganizationList { items, pagination }

items: Array<Organization { id, billing_email, billing_state, 11 more } >

id: string

Organization ID.

billing_email: string | null

Billing email. Null when no custom billing email is set (reverts to the oldest owner’s email).

billing_state: "unfunded" | "active" | "requires_action" | 2 more

Organization billing lifecycle state.

One of the following:

"unfunded"

"active"

"requires_action"

"suspended"

"closed"

billing_state_since: string

When the organization entered its current billing state.

formatdate-time

charging_model: "manual" | "prepaid"

How the organization is charged for resource usage.

One of the following:

"manual"

"prepaid"

created_at: string

When the Organization was created.

formatdate-time

domains: Array<OrganizationDomain { id, domain, verified } >

Domains associated with the organization.

id: string

Domain ID.

domain: string

Domain name.

verified: boolean

Whether the domain has been verified.

name: string

Organization name.

personal: boolean

Whether the organization is a personal Organization.

services: OrganizationServices { cloud, jit_provisioning, scim, 2 more }

Services that the Organization has access to.

cloud: boolean

Whether cloud services are enabled for the organization.

jit_provisioning: boolean

Whether just-in-time provisioning is enabled for the organization.

scim: boolean

Whether SCIM provisioning is enabled for the organization.

siem: boolean

Whether SIEM integration is enabled for the organization.

sso: boolean

Whether single sign-on is enabled for the organization.

stripe_customer_id: string | null

Stripe customer ID.

type: OrganizationType

Organization type.

One of the following:

"personal"

"company"

updated_at: string

When the Organization was updated.

formatdate-time

auth_id?: string

Authentication provider organization ID.

pagination: Pagination { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string | null

previous_cursor: string | null

total_count: number

minimum0

OrganizationServices { cloud, jit_provisioning, scim, 2 more }

Services that the Organization has access to.

cloud: boolean

Whether cloud services are enabled for the organization.

jit_provisioning: boolean

Whether just-in-time provisioning is enabled for the organization.

scim: boolean

Whether SCIM provisioning is enabled for the organization.

siem: boolean

Whether SIEM integration is enabled for the organization.

sso: boolean

Whether single sign-on is enabled for the organization.

OrganizationType = "personal" | "company"

Organization type.

One of the following:

"personal"

"company"

OrganizationsMemberships

Get Organization Membership

client.organizations.memberships.get(, , ?): OrganizationMembership { id, created_at, organization_id, 3 more }

GET/v1/organizations/{organization_id}/memberships/{membership_id}

List Organization Memberships

client.organizations.memberships.list(, ?, ?): Cursor<OrganizationMembership { id, created_at, organization_id, 3 more } >

GET/v1/organizations/{organization_id}/memberships

ModelsExpand Collapse

OrganizationMembership { id, created_at, organization_id, 3 more }

Organization membership details.

id: string

Membership ID.

created_at: string

When the membership was created.

formatdate-time

organization_id: string

Organization ID.

role: "owner" | "member"

Role of the user in the organization.

One of the following:

"owner"

"member"

updated_at: string

When the membership was updated.

formatdate-time

user_id: string

User ID.

OrganizationMembershipList { items, pagination }

items: Array<OrganizationMembership { id, created_at, organization_id, 3 more } >

id: string

Membership ID.

created_at: string

When the membership was created.

formatdate-time

organization_id: string

Organization ID.

role: "owner" | "member"

Role of the user in the organization.

One of the following:

"owner"

"member"

updated_at: string

When the membership was updated.

formatdate-time

user_id: string

User ID.

pagination: Pagination { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string | null

previous_cursor: string | null

total_count: number

minimum0

OrganizationsAddress

Create Organization Address

client.organizations.address.create(, , ?): OrganizationAddress { id, city, country, 9 more }

POST/v1/organizations/{organization_id}/address

Get Organization Address

client.organizations.address.get(, ?): OrganizationAddress { id, city, country, 9 more }

GET/v1/organizations/{organization_id}/address

Update Organization Address

client.organizations.address.update(, , ?): OrganizationAddress { id, city, country, 9 more }

PATCH/v1/organizations/{organization_id}/address

ModelsExpand Collapse

OrganizationAddress { id, city, country, 9 more }

Organization address details.

id: string

Address ID.

city: string

City or locality.

country: string

Two-letter ISO 3166-1 alpha-2 country code.

created_at: string

When the address was created.

formatdate-time

line1: string

First line of the street address.

line2: string | null

Second line of the street address. Null when not provided.

organization_id: string

Organization ID the address belongs to.

postal_code: string

Postal or ZIP code.

state: string | null

State, province, or region. Null when not provided.

tax_id: string | null

Tax identification number. Null when not provided.

tax_id_type: string | null

Type of the tax identification number. Null when not provided.

updated_at: string

When the address was updated.

formatdate-time

OrganizationsBilling

Get Organization Billing Summary

client.organizations.billing.summary(, ?): OrganizationBillingSummary { daily_cost, effective_balance, monthly_cost, 3 more }

GET/v1/organizations/{organization_id}/billing/summary

Get Organization Daily Cost

client.organizations.billing.cost(, ?, ?): OrganizationDailyCost { currency, days, from, to }

GET/v1/organizations/{organization_id}/billing/cost

List Organization Billing History

client.organizations.billing.history(, ?, ?): BillingHistoryEntryList { items, pagination }

GET/v1/organizations/{organization_id}/billing/history

Top Up Organization Prepaid Balance

client.organizations.billing.topUp(, , ?): OrganizationBillingSummary { daily_cost, effective_balance, monthly_cost, 3 more }

POST/v1/organizations/{organization_id}/billing/topup

ModelsExpand Collapse

BillingHistoryEntry { id, amount, created_at, 3 more }

A single billing history line item: a prepaid credit or a manual adjustment.

id: string

Unique identifier for the entry.

amount: string

Arbitrary-precision decimal serialized as a string (e.g. “58.40”).

formatdecimal

created_at: string

When the entry was recorded.

formatdate-time

currency: string

ISO 4217 currency code.

type: BillingHistoryEntryType

Kind of entry.

One of the following:

"grant"

"adjustment"

description?: string | null

Human-readable note describing the entry, when available.

BillingHistoryEntryList { items, pagination }

items: Array<BillingHistoryEntry { id, amount, created_at, 3 more } >

id: string

Unique identifier for the entry.

amount: string

Arbitrary-precision decimal serialized as a string (e.g. “58.40”).

formatdecimal

created_at: string

When the entry was recorded.

formatdate-time

currency: string

ISO 4217 currency code.

type: BillingHistoryEntryType

Kind of entry.

One of the following:

"grant"

"adjustment"

description?: string | null

Human-readable note describing the entry, when available.

pagination: Pagination { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string | null

previous_cursor: string | null

total_count: number

minimum0

BillingHistoryEntryType = "grant" | "adjustment"

Kind of entry.

One of the following:

"grant"

"adjustment"

DailyCostPoint { cost, date }

Total usage cost for a single UTC day.

cost: string

Arbitrary-precision decimal serialized as a string (e.g. “58.40”).

formatdecimal

date: string

UTC calendar day (YYYY-MM-DD).

OrganizationDailyCost { currency, days, from, to }

Daily usage cost over a date range: one entry per UTC day (zero on idle days), summing open and closed resources. Suitable for a daily cost bar chart.

currency: string

ISO 4217 currency code.

days: Array<DailyCostPoint { cost, date } >

One entry per UTC day in the range, oldest first.

cost: string

Arbitrary-precision decimal serialized as a string (e.g. “58.40”).

formatdecimal

date: string

UTC calendar day (YYYY-MM-DD).

from: string

Inclusive start of the range, as a UTC calendar day (YYYY-MM-DD).

to: string

Inclusive end of the range, as a UTC calendar day (YYYY-MM-DD).