---
title: Organization
description: Represents an organization owner of teamspaces and studios.
canonical: 'https://lightning.ai/docs/sdk/stable/api/organization'
---
# Organization {#organization}

### `class lightning_sdk.Organization(name=None)` {#lightning_sdk.Organization}

Bases: [`Owner`](/docs/sdk/2026.11.04/api/owner.md#lightning_sdk.owner.Owner "lightning_sdk.owner.Owner")

Represents an organization owner of teamspaces and studios.

Parameters:

*   **name** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional "(in Python v3.15)")\[[`str`](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)")\]) – the name of the organization
    
*   **name** ([_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") _|_ _None_)
    

Note

Arguments will be automatically inferred from environment variables if possible, unless explicitly specified

#### `create_teamspace(name)` {#lightning_sdk.Organization.create_teamspace}

Create a new teamspace owned by this organization.

Parameters:

*   **name** ([`str`](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)")) – The name for the new teamspace.
    
*   **name** ([_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)"))
    

Returns:

The newly created teamspace.

Return type:

[Teamspace](/docs/sdk/2026.11.04/api/teamspace.md#lightning_sdk.Teamspace "lightning_sdk.Teamspace")

#### `get_activity(teamspace=None, teamspaces=None, filters=None, cursor=None)` {#lightning_sdk.Organization.get_activity}

Get billing activity for this organization, or one or more of its teamspaces.

Returns paginated, per resource rollup rows keyed by raw IDs (no resolved names). For a resolved-name, non-paginated report meant for reading or exporting, use [`get_session_activity()`](#lightning_sdk.Organization.get_session_activity "lightning_sdk.Organization.get_session_activity") (one row per session) or [`get_resource_activity()`](#lightning_sdk.Organization.get_resource_activity "lightning_sdk.Organization.get_resource_activity") (one row per resource) instead.

Parameters:

*   **teamspace** (`Union`\[[`str`](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)"), [`Teamspace`](/docs/sdk/2026.11.04/api/teamspace.md#lightning_sdk.Teamspace "lightning_sdk.teamspace.Teamspace"), [`None`](https://docs.python.org/3/builtins/constants.html#None "(in Python v3.15)")\]) – A single teamspace to scope the query to.
    
*   **teamspaces** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional "(in Python v3.15)")\[[`List`](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.15)")\[`Union`\[[`str`](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)"), [`Teamspace`](/docs/sdk/2026.11.04/api/teamspace.md#lightning_sdk.Teamspace "lightning_sdk.teamspace.Teamspace")\]\]\]) – Multiple teamspaces to scope the query to. Provide at most one of `teamspace`/`teamspaces`. If neither is given, the query covers the whole organization.
    
*   **filters** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional "(in Python v3.15)")\[[`BillingActivityFilters`](#lightning_sdk.BillingActivityFilters "lightning_sdk.organization.BillingActivityFilters")\]) – Optional filters to narrow down the query.
    
*   **cursor** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional "(in Python v3.15)")\[[`BillingActivityCursor`](#lightning_sdk.BillingActivityCursor "lightning_sdk.organization.BillingActivityCursor")\]) – Optional pagination cursor to continue a previous query.
    
*   **teamspace** ([_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") _|_ [_Teamspace_](/docs/sdk/2026.11.04/api/teamspace.md#lightning_sdk.Teamspace "lightning_sdk.teamspace.Teamspace") _|_ _None_)
    
*   **teamspaces** ([_List_](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.15)")_\[_[_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") _|_ [_Teamspace_](/docs/sdk/2026.11.04/api/teamspace.md#lightning_sdk.Teamspace "lightning_sdk.teamspace.Teamspace")_\]_ _|_ _None_)
    
*   **filters** ([_BillingActivityFilters_](#lightning_sdk.BillingActivityFilters "lightning_sdk.organization.BillingActivityFilters") _|_ _None_)
    
*   **cursor** ([_BillingActivityCursor_](#lightning_sdk.BillingActivityCursor "lightning_sdk.organization.BillingActivityCursor") _|_ _None_)
    

Returns:

The usage report response.

Return type:

[BillingActivity](#lightning_sdk.BillingActivity "lightning_sdk.BillingActivity")

#### `get_activity_filter_values(teamspace=None)` {#lightning_sdk.Organization.get_activity_filter_values}

Get the set of values a billing activity query can be filtered by.

Parameters:

*   **teamspace** (`Union`\[[`str`](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)"), [`Teamspace`](/docs/sdk/2026.11.04/api/teamspace.md#lightning_sdk.Teamspace "lightning_sdk.teamspace.Teamspace"), [`None`](https://docs.python.org/3/builtins/constants.html#None "(in Python v3.15)")\]) – Optionally scope to a single teamspace. If omitted, covers the whole organization.
    
*   **teamspace** ([_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") _|_ [_Teamspace_](/docs/sdk/2026.11.04/api/teamspace.md#lightning_sdk.Teamspace "lightning_sdk.teamspace.Teamspace") _|_ _None_)
    

Returns:

The available filter values.

Return type:

[BillingActivityFilterValues](#lightning_sdk.BillingActivityFilterValues "lightning_sdk.BillingActivityFilterValues")

#### `get_monthly_summary(start=None, end=None)` {#lightning_sdk.Organization.get_monthly_summary}

Returns a monthly summary of credits purchased, used, and remaining.

Exactly one of `start` and `end` must be supplied, or both together:

*   only `start`: grabs monthly summaries for months after `pivot=start`.
    
*   only `end`: grabs monthly summaries for months before `pivot=end`.
    
*   both `start` and `end`: acts as a normal range.
    

Parameters:

*   **start** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional "(in Python v3.15)")\[[`datetime`](https://docs.python.org/3/library/datetime.html#datetime.datetime "(in Python v3.15)")\]) – Start of the time range. If given without `end`, acts as an “AFTER” pivot.
    
*   **end** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional "(in Python v3.15)")\[[`datetime`](https://docs.python.org/3/library/datetime.html#datetime.datetime "(in Python v3.15)")\]) – End of the time range. If given without `start`, acts as a “BEFORE” pivot.
    
*   **start** ([_datetime_](https://docs.python.org/3/library/datetime.html#datetime.datetime "(in Python v3.15)") _|_ _None_)
    
*   **end** ([_datetime_](https://docs.python.org/3/library/datetime.html#datetime.datetime "(in Python v3.15)") _|_ _None_)
    

Return type:

[`list`](https://docs.python.org/3/builtins/stdtypes.html#list "(in Python v3.15)")\[[`MonthlySummary`](#lightning_sdk.api.org_api.MonthlySummary "lightning_sdk.api.org_api.MonthlySummary")\]

Returns:

A list of [`MonthlySummary`](#lightning_sdk.api.org_api.MonthlySummary "lightning_sdk.api.org_api.MonthlySummary") dicts, one per month in the requested range:

```python
[
    {
        "period_start": datetime,
        "period_end": datetime,
        "total_credits_remaining": float,
        "total_credits_purchased": float,
    },
    ...
]
```

Raises:

[**ValueError**](https://docs.python.org/3/builtins/exceptions.html#ValueError "(in Python v3.15)") – If neither `start` nor `end` is provided, if `start` is after `end`, or if an “AFTER” pivot (derived from a lone `start`) is in the future.

#### `get_resource_activity(writer, format=ActivityFileFormat.JSON, teamspace=None, teamspaces=None, filters=None, cursor=None)` {#lightning_sdk.Organization.get_resource_activity}

Get the resource-level billing activity report for this organization, as CSV or JSON.

One row per resource (e.g. a Studio or Job) that was active in the queried time range, rather than one row per session; use [`get_session_activity()`](#lightning_sdk.Organization.get_session_activity "lightning_sdk.Organization.get_session_activity") for the finer-grained, per-session breakdown of a resource’s activity.

Parameters:

*   **writer** ([`IO`](https://docs.python.org/3/library/typing.html#typing.IO "(in Python v3.15)")\[[`str`](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)")\]) – Writable text stream to write the report to, e.g. an open file, an `io.StringIO` buffer, or `sys.stdout`. To get the JSON as a string rather than writing it to a file, pass an `io.StringIO()` and read it back with `.getvalue()`.
    
*   **format** ([`ActivityFileFormat`](#lightning_sdk.ActivityFileFormat "lightning_sdk.api.billing_api.ActivityFileFormat")) – File format to return the report in, either CSV or JSON. Defaults to JSON.
    
*   **teamspace** (`Union`\[[`str`](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)"), [`Teamspace`](/docs/sdk/2026.11.04/api/teamspace.md#lightning_sdk.Teamspace "lightning_sdk.teamspace.Teamspace"), [`None`](https://docs.python.org/3/builtins/constants.html#None "(in Python v3.15)")\]) – A single teamspace to scope the report to.
    
*   **teamspaces** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional "(in Python v3.15)")\[[`List`](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.15)")\[`Union`\[[`str`](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)"), [`Teamspace`](/docs/sdk/2026.11.04/api/teamspace.md#lightning_sdk.Teamspace "lightning_sdk.teamspace.Teamspace")\]\]\]) – Multiple teamspaces to scope the report to. Provide at most one of `teamspace`/`teamspaces`.
    
*   **filters** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional "(in Python v3.15)")\[[`BillingActivityFilters`](#lightning_sdk.BillingActivityFilters "lightning_sdk.organization.BillingActivityFilters")\]) – Optional filters to narrow down the report.
    
*   **cursor** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional "(in Python v3.15)")\[[`BillingActivityCursor`](#lightning_sdk.BillingActivityCursor "lightning_sdk.organization.BillingActivityCursor")\]) – Optional pagination cursor to continue a previous query.
    
*   **writer** ([_IO_](https://docs.python.org/3/library/typing.html#typing.IO "(in Python v3.15)")_\[_[_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)")_\]_)
    
*   **format** ([_ActivityFileFormat_](#lightning_sdk.ActivityFileFormat "lightning_sdk.api.billing_api.ActivityFileFormat"))
    
*   **teamspace** ([_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") _|_ [_Teamspace_](/docs/sdk/2026.11.04/api/teamspace.md#lightning_sdk.Teamspace "lightning_sdk.teamspace.Teamspace") _|_ _None_)
    
*   **teamspaces** ([_List_](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.15)")_\[_[_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") _|_ [_Teamspace_](/docs/sdk/2026.11.04/api/teamspace.md#lightning_sdk.Teamspace "lightning_sdk.teamspace.Teamspace")_\]_ _|_ _None_)
    
*   **filters** ([_BillingActivityFilters_](#lightning_sdk.BillingActivityFilters "lightning_sdk.organization.BillingActivityFilters") _|_ _None_)
    
*   **cursor** ([_BillingActivityCursor_](#lightning_sdk.BillingActivityCursor "lightning_sdk.organization.BillingActivityCursor") _|_ _None_)
    

Return type:

[`None`](https://docs.python.org/3/builtins/constants.html#None "(in Python v3.15)")

#### `get_session_activity(writer, format=ActivityFileFormat.JSON, teamspace=None, teamspaces=None, filters=None, cursor=None)` {#lightning_sdk.Organization.get_session_activity}

Get the session-level billing activity report for this organization, as CSV or JSON.

One row per session. A resource (e.g. a Studio or Job) can have many sessions within the queried time range, so this report is the finer-grained of the two; use [`get_resource_activity()`](#lightning_sdk.Organization.get_resource_activity "lightning_sdk.Organization.get_resource_activity") for one row per resource instead.

Parameters:

*   **writer** ([`IO`](https://docs.python.org/3/library/typing.html#typing.IO "(in Python v3.15)")\[[`str`](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)")\]) – Writable text stream to write the report to, e.g. an open file, an `io.StringIO` buffer, or `sys.stdout`. To get the JSON as a string rather than writing it to a file, pass an `io.StringIO()` and read it back with `.getvalue()`.
    
*   **format** ([`ActivityFileFormat`](#lightning_sdk.ActivityFileFormat "lightning_sdk.api.billing_api.ActivityFileFormat")) – File format to return the report in, either CSV or JSON. Defaults to JSON.
    
*   **teamspace** (`Union`\[[`str`](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)"), [`Teamspace`](/docs/sdk/2026.11.04/api/teamspace.md#lightning_sdk.Teamspace "lightning_sdk.teamspace.Teamspace"), [`None`](https://docs.python.org/3/builtins/constants.html#None "(in Python v3.15)")\]) – A single teamspace to scope the report to.
    
*   **teamspaces** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional "(in Python v3.15)")\[[`List`](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.15)")\[`Union`\[[`str`](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)"), [`Teamspace`](/docs/sdk/2026.11.04/api/teamspace.md#lightning_sdk.Teamspace "lightning_sdk.teamspace.Teamspace")\]\]\]) – Multiple teamspaces to scope the report to. Provide at most one of `teamspace`/`teamspaces`.
    
*   **filters** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional "(in Python v3.15)")\[[`BillingActivityFilters`](#lightning_sdk.BillingActivityFilters "lightning_sdk.organization.BillingActivityFilters")\]) – Optional filters to narrow down the report.
    
*   **cursor** ([`Optional`](https://docs.python.org/3/library/typing.html#typing.Optional "(in Python v3.15)")\[[`BillingActivityCursor`](#lightning_sdk.BillingActivityCursor "lightning_sdk.organization.BillingActivityCursor")\]) – Optional pagination cursor to continue a previous query.
    
*   **writer** ([_IO_](https://docs.python.org/3/library/typing.html#typing.IO "(in Python v3.15)")_\[_[_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)")_\]_)
    
*   **format** ([_ActivityFileFormat_](#lightning_sdk.ActivityFileFormat "lightning_sdk.api.billing_api.ActivityFileFormat"))
    
*   **teamspace** ([_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") _|_ [_Teamspace_](/docs/sdk/2026.11.04/api/teamspace.md#lightning_sdk.Teamspace "lightning_sdk.teamspace.Teamspace") _|_ _None_)
    
*   **teamspaces** ([_List_](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.15)")_\[_[_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") _|_ [_Teamspace_](/docs/sdk/2026.11.04/api/teamspace.md#lightning_sdk.Teamspace "lightning_sdk.teamspace.Teamspace")_\]_ _|_ _None_)
    
*   **filters** ([_BillingActivityFilters_](#lightning_sdk.BillingActivityFilters "lightning_sdk.organization.BillingActivityFilters") _|_ _None_)
    
*   **cursor** ([_BillingActivityCursor_](#lightning_sdk.BillingActivityCursor "lightning_sdk.organization.BillingActivityCursor") _|_ _None_)
    

Return type:

[`None`](https://docs.python.org/3/builtins/constants.html#None "(in Python v3.15)")

#### `property default_cloud_account: str | None` {#lightning_sdk.Organization.default_cloud_account}

The organization’s preferred cloud account ID, or None if not set.

Returns:

The preferred cloud account ID.

Return type:

[str](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") | None

#### `property id: str` {#lightning_sdk.Organization.id}

The organization’s ID.

#### `property name: str` {#lightning_sdk.Organization.name}

The organization’s name.

### `class lightning_sdk.api.org_api.MonthlySummary` {#lightning_sdk.api.org_api.MonthlySummary}

Bases: [`TypedDict`](https://docs.python.org/3/library/typing.html#typing.TypedDict "(in Python v3.15)")

A single month’s billing summary of credits purchased, used, and remaining.

#### `period_start` {#lightning_sdk.api.org_api.MonthlySummary.period_start}

Start of the billing period (typically the first of the month).

#### `period_end` {#lightning_sdk.api.org_api.MonthlySummary.period_end}

End of the billing period (typically the end of the month).

#### `total_credits_remaining` {#lightning_sdk.api.org_api.MonthlySummary.total_credits_remaining}

Total credits remaining at the end of the monthly period.

#### `total_credits_purchased` {#lightning_sdk.api.org_api.MonthlySummary.total_credits_purchased}

Total credits purchased during the monthly period.

### `class lightning_sdk.BillingActivityFilters(resource_types=None, resource_ids=None, user_ids=None, start=None, end=None, limit=None)` {#lightning_sdk.BillingActivityFilters}

Bases: [`object`](https://docs.python.org/3/builtins/functions.html#object "(in Python v3.15)")

Filters for narrowing down a billing activity query.

Parameters:

*   **resource\_types** ([_List_](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.15)")_\[_[_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)")_\]_ _|_ _None_)
    
*   **resource\_ids** ([_List_](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.15)")_\[_[_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)")_\]_ _|_ _None_)
    
*   **user\_ids** ([_List_](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.15)")_\[_[_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)")_\]_ _|_ _None_)
    
*   **start** ([_datetime_](https://docs.python.org/3/library/datetime.html#datetime.datetime "(in Python v3.15)") _|_ _None_)
    
*   **end** ([_datetime_](https://docs.python.org/3/library/datetime.html#datetime.datetime "(in Python v3.15)") _|_ _None_)
    
*   **limit** ([_int_](https://docs.python.org/3/builtins/functions.html#int "(in Python v3.15)") _|_ _None_)
    

#### `resource_types` {#lightning_sdk.BillingActivityFilters.resource_types}

Only include activity for these resource types (e.g. “Studio”, “Job”).

#### `resource_ids` {#lightning_sdk.BillingActivityFilters.resource_ids}

Only include activity for these specific resource IDs.

#### `user_ids` {#lightning_sdk.BillingActivityFilters.user_ids}

Only include activity generated by these users.

#### `start` {#lightning_sdk.BillingActivityFilters.start}

Only include activity on or after this time.

#### `end` {#lightning_sdk.BillingActivityFilters.end}

Only include activity on or before this time.

#### `limit` {#lightning_sdk.BillingActivityFilters.limit}

Maximum number of entries to return.

### `class lightning_sdk.BillingActivityCursor(search_after=None, search_after_resource_id=None, search_after_resource_type=None)` {#lightning_sdk.BillingActivityCursor}

Bases: [`object`](https://docs.python.org/3/builtins/functions.html#object "(in Python v3.15)")

Pagination cursor for continuing a billing activity query.

Parameters:

*   **search\_after** ([_datetime_](https://docs.python.org/3/library/datetime.html#datetime.datetime "(in Python v3.15)") _|_ _None_)
    
*   **search\_after\_resource\_id** ([_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") _|_ _None_)
    
*   **search\_after\_resource\_type** ([_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") _|_ _None_)
    

#### `search_after` {#lightning_sdk.BillingActivityCursor.search_after}

Only include entries strictly after this time.

#### `search_after_resource_id` {#lightning_sdk.BillingActivityCursor.search_after_resource_id}

Resource ID of the last entry from the previous page. Required alongside `search_after` to break ties between resources sharing the same time.

#### `search_after_resource_type` {#lightning_sdk.BillingActivityCursor.search_after_resource_type}

Resource type of the last entry from the previous page. Required alongside `search_after` to break ties between resources sharing the same time.

### `class lightning_sdk.ActivityFileFormat(*values)` {#lightning_sdk.ActivityFileFormat}

Bases: [`str`](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)"), [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.15)")

File format to return a billing activity report in.

### `class lightning_sdk.BillingActivity(total_cost=None, total_saved_cost=None, usage=<factory>, daily_usage=<factory>, has_more=False, search_after=None, search_after_resource_id=None, search_after_resource_type=None)` {#lightning_sdk.BillingActivity}

Bases: [`object`](https://docs.python.org/3/builtins/functions.html#object "(in Python v3.15)")

Billing activity for an org/teamspace scope, as returned by the V2 usage report endpoint.

Parameters:

*   **total\_cost** ([_float_](https://docs.python.org/3/builtins/functions.html#float "(in Python v3.15)") _|_ _None_)
    
*   **total\_saved\_cost** ([_float_](https://docs.python.org/3/builtins/functions.html#float "(in Python v3.15)") _|_ _None_)
    
*   **usage** ([_List_](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.15)")_\[_[_BillingResourceUsage_](#lightning_sdk.BillingResourceUsage "lightning_sdk.api.billing_api.BillingResourceUsage")_\]_)
    
*   **daily\_usage** ([_List_](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.15)")_\[_[_BillingDailyUsage_](#lightning_sdk.BillingDailyUsage "lightning_sdk.api.billing_api.BillingDailyUsage")_\]_)
    
*   **has\_more** ([_bool_](https://docs.python.org/3/builtins/functions.html#bool "(in Python v3.15)"))
    
*   **search\_after** ([_datetime_](https://docs.python.org/3/library/datetime.html#datetime.datetime "(in Python v3.15)") _|_ _None_)
    
*   **search\_after\_resource\_id** ([_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") _|_ _None_)
    
*   **search\_after\_resource\_type** ([_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") _|_ _None_)
    

#### `total_cost` {#lightning_sdk.BillingActivity.total_cost}

Total credits spent by all filtered resources during the queried time range.

#### `total_saved_cost` {#lightning_sdk.BillingActivity.total_saved_cost}

Total credits saved by all filtered resources during the queried time range.

#### `usage` {#lightning_sdk.BillingActivity.usage}

Per-resource usage/cost, one entry per filtered resource.

#### `daily_usage` {#lightning_sdk.BillingActivity.daily_usage}

Usage/cost aggregated by day.

#### `has_more` {#lightning_sdk.BillingActivity.has_more}

Whether more entries are available past `limit`. If `True`, pass a [`BillingActivityCursor`](#lightning_sdk.BillingActivityCursor "lightning_sdk.organization.BillingActivityCursor") built from `search_after`, `search_after_resource_id`, and `search_after_resource_type` to fetch the next page.

#### `search_after` {#lightning_sdk.BillingActivity.search_after}

Cursor value to continue pagination from. Only set when `limit` was provided on the request.

#### `search_after_resource_id` {#lightning_sdk.BillingActivity.search_after_resource_id}

Paired with `search_after` to break ties between resources sharing the same `search_after` time.

#### `search_after_resource_type` {#lightning_sdk.BillingActivity.search_after_resource_type}

Paired with `search_after` to break ties between resources sharing the same `search_after` time.

### `class lightning_sdk.BillingActivityFilterValues(project_ids=<factory>, resource_ids=<factory>, resource_ids_truncated=False, resource_types=<factory>, user_ids=<factory>)` {#lightning_sdk.BillingActivityFilterValues}

Bases: [`object`](https://docs.python.org/3/builtins/functions.html#object "(in Python v3.15)")

The set of values a billing activity query can be filtered by, for a given scope.

Parameters:

*   **project\_ids** ([_List_](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.15)")_\[_[_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)")_\]_)
    
*   **resource\_ids** ([_List_](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.15)")_\[_[_BillingNamedFilterValue_](#lightning_sdk.BillingNamedFilterValue "lightning_sdk.api.billing_api.BillingNamedFilterValue")_\]_)
    
*   **resource\_ids\_truncated** ([_bool_](https://docs.python.org/3/builtins/functions.html#bool "(in Python v3.15)"))
    
*   **resource\_types** ([_List_](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.15)")_\[_[_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)")_\]_)
    
*   **user\_ids** ([_List_](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.15)")_\[_[_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)")_\]_)
    

#### `project_ids` {#lightning_sdk.BillingActivityFilterValues.project_ids}

Teamspace (project) IDs with billing activity in the queried scope.

#### `resource_ids` {#lightning_sdk.BillingActivityFilterValues.resource_ids}

Resource IDs with billing activity in the queried scope, paired with their display names.

#### `resource_ids_truncated` {#lightning_sdk.BillingActivityFilterValues.resource_ids_truncated}

Whether `resource_ids` was truncated due to too many results.

#### `resource_types` {#lightning_sdk.BillingActivityFilterValues.resource_types}

Resource types with billing activity in the queried scope.

#### `user_ids` {#lightning_sdk.BillingActivityFilterValues.user_ids}

User IDs with billing activity in the queried scope.

### `class lightning_sdk.BillingResourceUsage(id=None, user_id=None, project_id=None, cluster_id=None, resource_type=None, resource_name=None, created_at=None, deleted_at=None, billed_time_seconds=None, cost=None, saved_cost=None, bucket_start=None)` {#lightning_sdk.BillingResourceUsage}

Bases: [`object`](https://docs.python.org/3/builtins/functions.html#object "(in Python v3.15)")

A single resource’s usage/cost within a billing activity report.

Parameters:

*   **id** ([_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") _|_ _None_)
    
*   **user\_id** ([_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") _|_ _None_)
    
*   **project\_id** ([_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") _|_ _None_)
    
*   **cluster\_id** ([_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") _|_ _None_)
    
*   **resource\_type** ([_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") _|_ _None_)
    
*   **resource\_name** ([_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") _|_ _None_)
    
*   **created\_at** ([_datetime_](https://docs.python.org/3/library/datetime.html#datetime.datetime "(in Python v3.15)") _|_ _None_)
    
*   **deleted\_at** ([_datetime_](https://docs.python.org/3/library/datetime.html#datetime.datetime "(in Python v3.15)") _|_ _None_)
    
*   **billed\_time\_seconds** ([_int_](https://docs.python.org/3/builtins/functions.html#int "(in Python v3.15)") _|_ _None_)
    
*   **cost** ([_float_](https://docs.python.org/3/builtins/functions.html#float "(in Python v3.15)") _|_ _None_)
    
*   **saved\_cost** ([_float_](https://docs.python.org/3/builtins/functions.html#float "(in Python v3.15)") _|_ _None_)
    
*   **bucket\_start** ([_datetime_](https://docs.python.org/3/library/datetime.html#datetime.datetime "(in Python v3.15)") _|_ _None_)
    

#### `id` {#lightning_sdk.BillingResourceUsage.id}

ID of the resource.

#### `user_id` {#lightning_sdk.BillingResourceUsage.user_id}

ID of the user that owns/started the resource.

#### `project_id` {#lightning_sdk.BillingResourceUsage.project_id}

ID of the teamspace (project) the resource belongs to.

#### `cluster_id` {#lightning_sdk.BillingResourceUsage.cluster_id}

ID of the cloud account the resource ran on.

#### `resource_type` {#lightning_sdk.BillingResourceUsage.resource_type}

Type of the resource (e.g. “Studio”, “Job”).

#### `resource_name` {#lightning_sdk.BillingResourceUsage.resource_name}

Name of the resource.

#### `created_at` {#lightning_sdk.BillingResourceUsage.created_at}

When the resource was created.

#### `deleted_at` {#lightning_sdk.BillingResourceUsage.deleted_at}

When the resource was deleted, if it has been.

#### `billed_time_seconds` {#lightning_sdk.BillingResourceUsage.billed_time_seconds}

Total billed time for this resource, in seconds.

#### `cost` {#lightning_sdk.BillingResourceUsage.cost}

Total credits spent by this resource.

#### `saved_cost` {#lightning_sdk.BillingResourceUsage.saved_cost}

Total credits saved by this resource.

#### `bucket_start` {#lightning_sdk.BillingResourceUsage.bucket_start}

Start of the usage rollup bucket this row represents.

### `class lightning_sdk.BillingDailyUsage(day=None, total_cost=None, total_saved_cost=None, total_prompt_tokens=None, total_completion_tokens=None, total_num_messages=None)` {#lightning_sdk.BillingDailyUsage}

Bases: [`object`](https://docs.python.org/3/builtins/functions.html#object "(in Python v3.15)")

Aggregated usage/cost for a single day within a billing activity report.

Parameters:

*   **day** ([_datetime_](https://docs.python.org/3/library/datetime.html#datetime.datetime "(in Python v3.15)") _|_ _None_)
    
*   **total\_cost** ([_float_](https://docs.python.org/3/builtins/functions.html#float "(in Python v3.15)") _|_ _None_)
    
*   **total\_saved\_cost** ([_float_](https://docs.python.org/3/builtins/functions.html#float "(in Python v3.15)") _|_ _None_)
    
*   **total\_prompt\_tokens** ([_int_](https://docs.python.org/3/builtins/functions.html#int "(in Python v3.15)") _|_ _None_)
    
*   **total\_completion\_tokens** ([_int_](https://docs.python.org/3/builtins/functions.html#int "(in Python v3.15)") _|_ _None_)
    
*   **total\_num\_messages** ([_int_](https://docs.python.org/3/builtins/functions.html#int "(in Python v3.15)") _|_ _None_)
    

#### `day` {#lightning_sdk.BillingDailyUsage.day}

The day this entry aggregates.

#### `total_cost` {#lightning_sdk.BillingDailyUsage.total_cost}

Total credits spent on this day.

#### `total_saved_cost` {#lightning_sdk.BillingDailyUsage.total_saved_cost}

Total credits saved on this day.

#### `total_prompt_tokens` {#lightning_sdk.BillingDailyUsage.total_prompt_tokens}

Total prompt tokens consumed on this day.

#### `total_completion_tokens` {#lightning_sdk.BillingDailyUsage.total_completion_tokens}

Total completion tokens consumed on this day.

#### `total_num_messages` {#lightning_sdk.BillingDailyUsage.total_num_messages}

Total number of messages sent on this day.

### `class lightning_sdk.BillingNamedFilterValue(id=None, name=None)` {#lightning_sdk.BillingNamedFilterValue}

Bases: [`object`](https://docs.python.org/3/builtins/functions.html#object "(in Python v3.15)")

A filterable resource ID paired with its display name.

Parameters:

*   **id** ([_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") _|_ _None_)
    
*   **name** ([_str_](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") _|_ _None_)
    

#### `id` {#lightning_sdk.BillingNamedFilterValue.id}

ID of the resource.

#### `name` {#lightning_sdk.BillingNamedFilterValue.name}

Display name of the resource.

---

**Navigation**

- Parent: [API Reference](/docs/sdk/2026.11.04/api.md)