# Organizations ## List organizations the user has access to `organizations.list(OrganizationListParams**kwargs) -> SyncSinglePage[Organization]` **get** `/organizations` Retrieve a list of organizations a particular user has access to. (Currently in Public Beta - see https://developers.cloudflare.com/fundamentals/organizations/) ### Parameters - `id: Optional[Sequence[str]]` Only return organizations with the specified IDs (ex. id=foo&id=bar). Send multiple elements by repeating the query value. - `containing: Optional[Containing]` - `account: Optional[str]` Filter the list of organizations to the ones that contain this particular account. - `organization: Optional[str]` Filter the list of organizations to the ones that contain this particular organization. - `user: Optional[str]` Filter the list of organizations to the ones that contain this particular user. IMPORTANT: Just because an organization "contains" a user is not a representation of any authorization or privilege to manage any resources therein. An organization "containing" a user simply means the user is managed by that organization. - `name: Optional[Name]` - `contains: Optional[str]` (case-insensitive) Filter the list of organizations to where the name contains a particular string. - `ends_with: Optional[str]` (case-insensitive) Filter the list of organizations to where the name ends with a particular string. - `starts_with: Optional[str]` (case-insensitive) Filter the list of organizations to where the name starts with a particular string. - `page_size: Optional[int]` The amount of items to return. Defaults to 10. - `page_token: Optional[str]` An opaque token returned from the last list response that when provided will retrieve the next page. Parameters used to filter the retrieved list must remain in subsequent requests with a page token. - `parent: Optional[Parent]` - `id: Optional[Union[str, Literal["null"]]]` Filter the list of organizations to the ones that are a sub-organization of the specified organization. "null" is a valid value to provide for this parameter. It means "where an organization has no parent (i.e. it is a 'root' organization)." - `str` - `Literal["null"]` Filter the list of organizations to the ones that are a sub-organization of the specified organization. "null" is a valid value to provide for this parameter. It means "where an organization has no parent (i.e. it is a 'root' organization)." - `"null"` ### Returns - `class Organization: …` References an Organization in the Cloudflare data model. - `id: str` - `create_time: datetime` - `meta: Meta` - `flags: Optional[MetaFlags]` Enable features for Organizations. - `account_creation: str` - `account_deletion: str` - `account_migration: str` - `account_mobility: str` - `sub_org_creation: str` - `hierarchy_tags: Optional[List[str]]` Ordered chain of organization tags from the root organization down to (and including) this organization itself. Root organizations return a single-element array containing their own tag; sub-organizations return `[rootTag, ...intermediateTags, parentTag, selfTag]`. Useful for constructing authorization scopes that need to cover every ancestor in the hierarchy. - `managed_by: Optional[str]` - `name: str` - `parent: Optional[Parent]` - `id: str` - `name: str` - `profile: Optional[Profile]` - `business_address: str` - `business_email: str` - `business_name: str` - `business_phone: str` - `external_metadata: str` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) page = client.organizations.list() page = page.result[0] print(page.id) ``` #### Response ```json { "errors": [], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": [ { "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", "create_time": "2019-12-27T18:11:19.117Z", "meta": { "flags": { "account_creation": "account_creation", "account_deletion": "account_deletion", "account_migration": "account_migration", "account_mobility": "account_mobility", "sub_org_creation": "sub_org_creation" }, "hierarchy_tags": [ "string" ], "managed_by": "managed_by" }, "name": "name", "parent": { "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", "name": "name" }, "profile": { "business_address": "business_address", "business_email": "business_email", "business_name": "business_name", "business_phone": "business_phone", "external_metadata": "external_metadata" } } ], "result_info": { "next_page_token": "next_page_token", "total_size": 0 }, "success": true } ``` ## Get organization `organizations.get(strorganization_id) -> Organization` **get** `/organizations/{organization_id}` Retrieve the details of a certain organization. (Currently in Public Beta - see https://developers.cloudflare.com/fundamentals/organizations/) ### Parameters - `organization_id: str` ### Returns - `class Organization: …` References an Organization in the Cloudflare data model. - `id: str` - `create_time: datetime` - `meta: Meta` - `flags: Optional[MetaFlags]` Enable features for Organizations. - `account_creation: str` - `account_deletion: str` - `account_migration: str` - `account_mobility: str` - `sub_org_creation: str` - `hierarchy_tags: Optional[List[str]]` Ordered chain of organization tags from the root organization down to (and including) this organization itself. Root organizations return a single-element array containing their own tag; sub-organizations return `[rootTag, ...intermediateTags, parentTag, selfTag]`. Useful for constructing authorization scopes that need to cover every ancestor in the hierarchy. - `managed_by: Optional[str]` - `name: str` - `parent: Optional[Parent]` - `id: str` - `name: str` - `profile: Optional[Profile]` - `business_address: str` - `business_email: str` - `business_name: str` - `business_phone: str` - `external_metadata: str` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_email=os.environ.get("CLOUDFLARE_EMAIL"), # This is the default and can be omitted api_key=os.environ.get("CLOUDFLARE_API_KEY"), # This is the default and can be omitted ) organization = client.organizations.get( "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", ) print(organization.id) ``` #### Response ```json { "errors": [], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", "create_time": "2019-12-27T18:11:19.117Z", "meta": { "flags": { "account_creation": "account_creation", "account_deletion": "account_deletion", "account_migration": "account_migration", "account_mobility": "account_mobility", "sub_org_creation": "sub_org_creation" }, "hierarchy_tags": [ "string" ], "managed_by": "managed_by" }, "name": "name", "parent": { "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", "name": "name" }, "profile": { "business_address": "business_address", "business_email": "business_email", "business_name": "business_name", "business_phone": "business_phone", "external_metadata": "external_metadata" } }, "success": true } ``` ## Create organization `organizations.create(OrganizationCreateParams**kwargs) -> Organization` **post** `/organizations` Create a new organization for a user. (Currently in Public Beta - see https://developers.cloudflare.com/fundamentals/organizations/) ### Parameters - `name: str` - `parent: Optional[Parent]` - `id: str` - `name: str` - `profile: Optional[Profile]` - `business_address: str` - `business_email: str` - `business_name: str` - `business_phone: str` - `external_metadata: str` ### Returns - `class Organization: …` References an Organization in the Cloudflare data model. - `id: str` - `create_time: datetime` - `meta: Meta` - `flags: Optional[MetaFlags]` Enable features for Organizations. - `account_creation: str` - `account_deletion: str` - `account_migration: str` - `account_mobility: str` - `sub_org_creation: str` - `hierarchy_tags: Optional[List[str]]` Ordered chain of organization tags from the root organization down to (and including) this organization itself. Root organizations return a single-element array containing their own tag; sub-organizations return `[rootTag, ...intermediateTags, parentTag, selfTag]`. Useful for constructing authorization scopes that need to cover every ancestor in the hierarchy. - `managed_by: Optional[str]` - `name: str` - `parent: Optional[Parent]` - `id: str` - `name: str` - `profile: Optional[Profile]` - `business_address: str` - `business_email: str` - `business_name: str` - `business_phone: str` - `external_metadata: str` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_email=os.environ.get("CLOUDFLARE_EMAIL"), # This is the default and can be omitted api_key=os.environ.get("CLOUDFLARE_API_KEY"), # This is the default and can be omitted ) organization = client.organizations.create( name="name", ) print(organization.id) ``` #### Response ```json { "errors": [], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", "create_time": "2019-12-27T18:11:19.117Z", "meta": { "flags": { "account_creation": "account_creation", "account_deletion": "account_deletion", "account_migration": "account_migration", "account_mobility": "account_mobility", "sub_org_creation": "sub_org_creation" }, "hierarchy_tags": [ "string" ], "managed_by": "managed_by" }, "name": "name", "parent": { "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", "name": "name" }, "profile": { "business_address": "business_address", "business_email": "business_email", "business_name": "business_name", "business_phone": "business_phone", "external_metadata": "external_metadata" } }, "success": true } ``` ## Modify organization. `organizations.update(strorganization_id, OrganizationUpdateParams**kwargs) -> Organization` **put** `/organizations/{organization_id}` Modify organization. (Currently in Public Beta - see https://developers.cloudflare.com/fundamentals/organizations/) ### Parameters - `organization_id: str` - `name: str` - `parent: Optional[Parent]` - `id: str` - `name: str` - `profile: Optional[Profile]` - `business_address: str` - `business_email: str` - `business_name: str` - `business_phone: str` - `external_metadata: str` ### Returns - `class Organization: …` References an Organization in the Cloudflare data model. - `id: str` - `create_time: datetime` - `meta: Meta` - `flags: Optional[MetaFlags]` Enable features for Organizations. - `account_creation: str` - `account_deletion: str` - `account_migration: str` - `account_mobility: str` - `sub_org_creation: str` - `hierarchy_tags: Optional[List[str]]` Ordered chain of organization tags from the root organization down to (and including) this organization itself. Root organizations return a single-element array containing their own tag; sub-organizations return `[rootTag, ...intermediateTags, parentTag, selfTag]`. Useful for constructing authorization scopes that need to cover every ancestor in the hierarchy. - `managed_by: Optional[str]` - `name: str` - `parent: Optional[Parent]` - `id: str` - `name: str` - `profile: Optional[Profile]` - `business_address: str` - `business_email: str` - `business_name: str` - `business_phone: str` - `external_metadata: str` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_email=os.environ.get("CLOUDFLARE_EMAIL"), # This is the default and can be omitted api_key=os.environ.get("CLOUDFLARE_API_KEY"), # This is the default and can be omitted ) organization = client.organizations.update( organization_id="a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", name="name", ) print(organization.id) ``` #### Response ```json { "errors": [], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", "create_time": "2019-12-27T18:11:19.117Z", "meta": { "flags": { "account_creation": "account_creation", "account_deletion": "account_deletion", "account_migration": "account_migration", "account_mobility": "account_mobility", "sub_org_creation": "sub_org_creation" }, "hierarchy_tags": [ "string" ], "managed_by": "managed_by" }, "name": "name", "parent": { "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", "name": "name" }, "profile": { "business_address": "business_address", "business_email": "business_email", "business_name": "business_name", "business_phone": "business_phone", "external_metadata": "external_metadata" } }, "success": true } ``` ## Delete organization. `organizations.delete(strorganization_id) -> OrganizationDeleteResponse` **delete** `/organizations/{organization_id}` Delete an organization. The organization MUST be empty before deleting. It must not contain any sub-organizations, accounts, members or users. (Currently in Public Beta - see https://developers.cloudflare.com/fundamentals/organizations/) **Access Control:** Restricted to enterprise organizations. ### Parameters - `organization_id: str` ### Returns - `class OrganizationDeleteResponse: …` - `id: str` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_email=os.environ.get("CLOUDFLARE_EMAIL"), # This is the default and can be omitted api_key=os.environ.get("CLOUDFLARE_API_KEY"), # This is the default and can be omitted ) organization = client.organizations.delete( "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", ) print(organization.id) ``` #### Response ```json { "errors": [], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "id" }, "success": true } ``` ## Domain Types ### Organization - `class Organization: …` References an Organization in the Cloudflare data model. - `id: str` - `create_time: datetime` - `meta: Meta` - `flags: Optional[MetaFlags]` Enable features for Organizations. - `account_creation: str` - `account_deletion: str` - `account_migration: str` - `account_mobility: str` - `sub_org_creation: str` - `hierarchy_tags: Optional[List[str]]` Ordered chain of organization tags from the root organization down to (and including) this organization itself. Root organizations return a single-element array containing their own tag; sub-organizations return `[rootTag, ...intermediateTags, parentTag, selfTag]`. Useful for constructing authorization scopes that need to cover every ancestor in the hierarchy. - `managed_by: Optional[str]` - `name: str` - `parent: Optional[Parent]` - `id: str` - `name: str` - `profile: Optional[Profile]` - `business_address: str` - `business_email: str` - `business_name: str` - `business_phone: str` - `external_metadata: str` ### Organization Delete Response - `class OrganizationDeleteResponse: …` - `id: str` # Organization Accounts # Organization Profile ## Get organization profile `organizations.organization_profile.get(strorganization_id) -> Result` **get** `/organizations/{organization_id}/profile` Get an organizations profile if it exists. (Currently in Public Beta - see https://developers.cloudflare.com/fundamentals/organizations/) ### Parameters - `organization_id: str` ### Returns - `Result` - `business_address: str` - `business_email: str` - `business_name: str` - `business_phone: str` - `external_metadata: str` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_email=os.environ.get("CLOUDFLARE_EMAIL"), # This is the default and can be omitted api_key=os.environ.get("CLOUDFLARE_API_KEY"), # This is the default and can be omitted ) organization_profile = client.organizations.organization_profile.get( "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", ) print(organization_profile.business_address) ``` #### Response ```json { "errors": [], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "business_address": "business_address", "business_email": "business_email", "business_name": "business_name", "business_phone": "business_phone", "external_metadata": "external_metadata" }, "success": true } ``` ## Modify organization profile. `organizations.organization_profile.update(strorganization_id, OrganizationProfileUpdateParams**kwargs)` **put** `/organizations/{organization_id}/profile` Modify organization profile. (Currently in Public Beta - see https://developers.cloudflare.com/fundamentals/organizations/) ### Parameters - `organization_id: str` - `business_address: str` - `business_email: str` - `business_name: str` - `business_phone: str` - `external_metadata: str` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_email=os.environ.get("CLOUDFLARE_EMAIL"), # This is the default and can be omitted api_key=os.environ.get("CLOUDFLARE_API_KEY"), # This is the default and can be omitted ) client.organizations.organization_profile.update( organization_id="a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", business_address="business_address", business_email="business_email", business_name="business_name", business_phone="business_phone", external_metadata="external_metadata", ) ``` ## Domain Types ### Organization Profile - `class OrganizationProfile: …` - `business_address: str` - `business_email: str` - `business_name: str` - `business_phone: str` - `external_metadata: str` # Members # Logs # Audit ## Get organization audit logs (Version 2, Beta release) `organizations.logs.audit.list(strorganization_id, AuditListParams**kwargs) -> SyncCursorPaginationAfter[AuditListResponse]` **get** `/organizations/{organization_id}/logs/audit` Gets a list of audit logs for an organization. ### Parameters - `organization_id: str` The unique id that identifies the organization. - `before: Union[null, null]` Limits the returned results to logs older than the specified date. This can be a date string 2019-04-30 (interpreted in UTC) or an absolute timestamp that conforms to RFC3339. - `since: Union[null, null]` Limits the returned results to logs newer than the specified date. This can be a date string 2019-04-30 (interpreted in UTC) or an absolute timestamp that conforms to RFC3339. - `id: Optional[ID]` - `not_: Optional[Sequence[str]]` Filters out audit logs by their IDs. - `action_result: Optional[ActionResult]` - `not_: Optional[List[Literal["success", "failure"]]]` Filters out audit logs by whether the action was successful or not. - `"success"` - `"failure"` - `action_type: Optional[ActionType]` - `not_: Optional[List[Literal["create", "delete", "view", "update"]]]` Filters out audit logs by the action type. - `"create"` - `"delete"` - `"view"` - `"update"` - `actor_context: Optional[ActorContext]` - `not_: Optional[List[Literal["api_key", "api_token", "dash", 2 more]]]` Filters out audit logs by the actor context. - `"api_key"` - `"api_token"` - `"dash"` - `"oauth"` - `"origin_ca_key"` - `actor_email: Optional[ActorEmail]` - `not_: Optional[Sequence[str]]` Filters out audit logs by the actor's email address. - `actor_id: Optional[ActorID]` - `not_: Optional[Sequence[str]]` Filters out audit logs by the actor's user ID. - `actor_ip_address: Optional[ActorIPAddress]` - `not_: Optional[Sequence[str]]` Filters out audit logs IP address where the action was initiated. - `actor_token_id: Optional[ActorTokenID]` - `not_: Optional[Sequence[str]]` Filters out audit logs by the API token ID when the actor context is an api_token or oauth. - `actor_token_name: Optional[ActorTokenName]` - `not_: Optional[Sequence[str]]` Filters out audit logs by the API token name when the actor context is an api_token or oauth. - `actor_type: Optional[ActorType]` - `not_: Optional[List[Literal["cloudflare_admin", "system", "user"]]]` Filters out audit logs by the actor type. - `"cloudflare_admin"` - `"system"` - `"user"` - `cursor: Optional[str]` The cursor is an opaque token used to paginate through large sets of records. It indicates the position from which to continue when requesting the next set of records. A valid cursor value can be obtained from the cursor object in the result_info structure of a previous response. - `direction: Optional[Literal["desc", "asc"]]` Sets sorting order. - `"desc"` - `"asc"` - `limit: Optional[float]` The number limits the objects to return. The cursor attribute may be used to iterate over the next batch of objects if there are more than the limit. - `raw_cf_rayid: Optional[RawCfRayID]` - `not_: Optional[Sequence[str]]` Filters out audit logs by the response CF Ray ID. - `raw_method: Optional[RawMethod]` - `not_: Optional[Sequence[str]]` Filters out audit logs by the HTTP method for the API call. - `raw_status_code: Optional[RawStatusCode]` - `not_: Optional[Iterable[int]]` Filters out audit logs by the response status code that was returned. - `raw_uri: Optional[RawURI]` - `not_: Optional[Sequence[str]]` Filters out audit logs by the request URI. - `resource_id: Optional[ResourceID]` - `not_: Optional[Sequence[str]]` Filters out audit logs by the resource ID. - `resource_product: Optional[ResourceProduct]` - `not_: Optional[Sequence[str]]` Filters out audit logs by the Cloudflare product associated with the changed resource. - `resource_scope: Optional[ResourceScope]` - `not_: Optional[List[Literal["organizations"]]]` Filters out audit logs by the resource scope, specifying whether the resource is associated with an organization. - `"organizations"` - `resource_type: Optional[ResourceType]` - `not_: Optional[Sequence[str]]` Filters out audit logs based on the unique type of resource changed by the action. ### Returns - `class AuditListResponse: …` - `id: Optional[str]` A unique identifier for the audit log entry. - `action: Optional[Action]` Provides information about the action performed. - `description: Optional[str]` A short description of the action performed. - `result: Optional[str]` The result of the action, indicating success or failure. - `time: Optional[datetime]` A timestamp indicating when the action was logged. - `type: Optional[str]` A short string that describes the action that was performed. - `actor: Optional[Actor]` Provides details about the actor who performed the action. - `id: Optional[str]` The ID of the actor who performed the action. If a user performed the action, this will be their User ID. - `context: Optional[Literal["api_key", "api_token", "dash", 2 more]]` - `"api_key"` - `"api_token"` - `"dash"` - `"oauth"` - `"origin_ca_key"` - `email: Optional[str]` The email of the actor who performed the action. - `ip_address: Optional[str]` The IP address of the request that performed the action. - `token_id: Optional[str]` The API token ID when the actor context is an api_token or oauth. - `token_name: Optional[str]` The API token name when the actor context is an api_token or oauth. - `type: Optional[Literal["cloudflare_admin", "system", "user"]]` The type of actor. - `"cloudflare_admin"` - `"system"` - `"user"` - `organization: Optional[Organization]` Contains organization related information. - `id: Optional[str]` A unique identifier for the organization. - `raw: Optional[Raw]` Provides raw information about the request and response. - `cf_rayid: Optional[str]` The Cloudflare Ray ID for the request. - `method: Optional[str]` The HTTP method of the request. - `status_code: Optional[int]` The HTTP response status code returned by the API. - `uri: Optional[str]` The URI of the request. - `user_agent: Optional[str]` The client's user agent string sent with the request. - `resource: Optional[Resource]` Provides details about the affected resource. - `id: Optional[str]` The unique identifier for the affected resource. - `product: Optional[str]` The Cloudflare product associated with the resource. - `request: Optional[object]` - `response: Optional[object]` - `scope: Optional[object]` The scope of the resource. - `type: Optional[str]` The type of the resource. ### Example ```python import os from datetime import date from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) page = client.organizations.logs.audit.list( organization_id="a67e14daa5f8dceeb91fe5449ba496ef", before=date.fromisoformat("2024-10-31"), since=date.fromisoformat("2024-10-30"), ) page = page.result[0] print(page.id) ``` #### Response ```json { "errors": [ { "message": "message" } ], "result": [ { "id": "023e105f4ecef8ad9ca31a8372d0c353", "action": { "description": "Add Member", "result": "success", "time": "2024-04-26T17:31:07Z", "type": "create" }, "actor": { "id": "f6b5de0326bb5182b8a4840ee01ec774", "context": "dash", "email": "alice@example.com", "ip_address": "198.41.129.166", "token_id": "token_id", "token_name": "token_name", "type": "user" }, "organization": { "id": "019c4f65e7607d8c9f6f6b58aa3aff50" }, "raw": { "cf_ray_id": "8e9b1c60ef9e1c9a", "method": "POST", "status_code": 200, "uri": "/accounts/4bb334f7c94c4a29a045f03944f072e5/members", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) Safari/605.1.15" }, "resource": { "id": "id", "product": "organizations", "request": {}, "response": {}, "scope": {}, "type": "type" } } ], "result_info": { "count": "1", "cursor": "ASqdKd7dKgxh-aZ8bm0mZos1BtW4BdEqifCzNkEeGRzi_5SN_-362Y8sF-C1TRn60_6rd3z2dIajf9EAPyQ_NmIeAMkacmaJPXipqvP7PLU4t72wyqBeJfjmjdE=" }, "success": true } ``` ## Domain Types ### Audit List Response - `class AuditListResponse: …` - `id: Optional[str]` A unique identifier for the audit log entry. - `action: Optional[Action]` Provides information about the action performed. - `description: Optional[str]` A short description of the action performed. - `result: Optional[str]` The result of the action, indicating success or failure. - `time: Optional[datetime]` A timestamp indicating when the action was logged. - `type: Optional[str]` A short string that describes the action that was performed. - `actor: Optional[Actor]` Provides details about the actor who performed the action. - `id: Optional[str]` The ID of the actor who performed the action. If a user performed the action, this will be their User ID. - `context: Optional[Literal["api_key", "api_token", "dash", 2 more]]` - `"api_key"` - `"api_token"` - `"dash"` - `"oauth"` - `"origin_ca_key"` - `email: Optional[str]` The email of the actor who performed the action. - `ip_address: Optional[str]` The IP address of the request that performed the action. - `token_id: Optional[str]` The API token ID when the actor context is an api_token or oauth. - `token_name: Optional[str]` The API token name when the actor context is an api_token or oauth. - `type: Optional[Literal["cloudflare_admin", "system", "user"]]` The type of actor. - `"cloudflare_admin"` - `"system"` - `"user"` - `organization: Optional[Organization]` Contains organization related information. - `id: Optional[str]` A unique identifier for the organization. - `raw: Optional[Raw]` Provides raw information about the request and response. - `cf_rayid: Optional[str]` The Cloudflare Ray ID for the request. - `method: Optional[str]` The HTTP method of the request. - `status_code: Optional[int]` The HTTP response status code returned by the API. - `uri: Optional[str]` The URI of the request. - `user_agent: Optional[str]` The client's user agent string sent with the request. - `resource: Optional[Resource]` Provides details about the affected resource. - `id: Optional[str]` The unique identifier for the affected resource. - `product: Optional[str]` The Cloudflare product associated with the resource. - `request: Optional[object]` - `response: Optional[object]` - `scope: Optional[object]` The scope of the resource. - `type: Optional[str]` The type of the resource. # Billing # Usage ## Get Organization Usage (Version 2, Alpha, Restricted) `organizations.billing.usage.get(strorganization_id, UsageGetParams**kwargs) -> UsageGetResponse` **get** `/organizations/{organization_id}/billable/usage` Returns cost and usage data for all accounts within an organization, aligned with the [FinOps FOCUS v1.3](https://focus.finops.org/focus-specification/v1-3/) Cost and Usage dataset specification. Each record represents one billable metric for one account on one day. This includes all metered usage, including usage that falls within free-tier allowances and may result in zero cost. The response includes usage for every account belonging to the specified organization. **Note:** Cost and pricing fields are not yet populated and will be absent from responses until billing integration is complete. When `from` and `to` are omitted, defaults to the start of the current month through today. The maximum date range is 31 days. ### Parameters - `organization_id: str` Represents a Cloudflare resource identifier tag. - `from_: Optional[Union[null, null]]` Start date for the usage query (ISO 8601). Required if `to` is set. When omitted along with `to`, defaults to the start of the current month. Filters by charge period (when consumption happened), not billing period. The maximum date range is 31 days. - `metric: Optional[str]` Filter results by billable metric id (e.g., workers_standard_requests). - `to: Optional[Union[null, null]]` End date for the usage query (ISO 8601). Required if `from` is set. When omitted along with `from`, defaults to today. Filters by charge period (when consumption happened), not billing period. The maximum date range is 31 days. ### Returns - `List[UsageGetResponseItem]` Contains the array of cost and usage records. - `billing_account_id: str` Public identifier of the Cloudflare account (account tag). - `billing_account_name: str` Display name of the Cloudflare account. - `charge_category: Literal["Usage"]` Highest-level classification of a charge based on the nature of how it gets billed. Currently only "Usage" is supported. - `"Usage"` - `charge_description: str` Self-contained summary of the charge's purpose and price. - `charge_frequency: Literal["Usage-Based"]` Indicates how often a charge occurs. Currently only "Usage-Based" is supported. - `"Usage-Based"` - `charge_period_end: datetime` Exclusive end of the time interval during which the usage was consumed. - `charge_period_start: datetime` Inclusive start of the time interval during which the usage was consumed. - `consumed_quantity: float` Measured usage amount within the charge period. Reflects raw metered consumption before pricing transformations. - `consumed_unit: str` Unit of measure for the consumed quantity (e.g., "GB", "Requests", "vCPU-Hours"). - `host_provider_name: str` Name of the entity providing the underlying infrastructure or platform. - `invoice_issuer_name: str` Name of the entity responsible for invoicing for the services consumed. - `service_provider_name: str` Name of the entity that made the services available for purchase. - `x_billable_metric_name: str` The display name of the billable metric. Cloudflare extension; replaces FOCUS SkuMeter. - `billed_cost: Optional[float]` A charge serving as the basis for invoicing, inclusive of all reduced rates and discounts while excluding the amortization of upfront charges (one-time or recurring). - `billing_currency: Optional[str]` Currency that a charge was billed in (ISO 4217). - `billing_period_end: Optional[datetime]` Exclusive end of the billing cycle that contains this usage record. - `billing_period_start: Optional[datetime]` Inclusive start of the billing cycle that contains this usage record. - `charge_class: Optional[Literal["Correction"]]` Indicates whether the row represents a correction to one or more charges invoiced in a previous billing period. - `"Correction"` - `contracted_cost: Optional[float]` Cost calculated by multiplying ContractedUnitPrice and the corresponding PricingQuantity. - `contracted_unit_price: Optional[float]` The agreed-upon unit price for a single PricingUnit of the associated billable metric, inclusive of negotiated discounts, if present, while excluding any other discounts. - `effective_cost: Optional[float]` The amortized cost of the charge after applying all reduced rates, discounts, and the applicable portion of relevant, prepaid purchases (one-time or recurring) that covered the charge. - `list_cost: Optional[float]` Cost calculated by multiplying ListUnitPrice and the corresponding PricingQuantity. - `list_unit_price: Optional[float]` Suggested provider-published unit price for a single PricingUnit of the associated billable metric, exclusive of any discounts. - `pricing_quantity: Optional[float]` Volume of a given service used or purchased, based on the PricingUnit. - `pricing_unit: Optional[str]` Provider-specified measurement unit for determining unit prices, indicating how the provider rates measured usage after applying pricing rules like block pricing. - `region_id: Optional[str]` Provider-assigned identifier for an isolated geographic area where a service is provided. - `region_name: Optional[str]` Name of an isolated geographic area where a service is provided. - `sub_account_id: Optional[str]` Unique identifier assigned to a grouping of services. For Cloudflare, this is the subscription or contract ID. - `sub_account_name: Optional[str]` Name assigned to a grouping of services. For Cloudflare, this is the subscription or contract display name. - `x_billable_metric_id: Optional[str]` The unique identifier for the billable metric in the Cloudflare catalog. Cloudflare extension; replaces FOCUS SkuId. - `x_product_family_name: Optional[str]` The product family the charge belongs to (e.g., "R2", "Workers"). Cloudflare extension; replaces FOCUS ServiceName. - `x_zone_id: Optional[str]` The identifier for the Cloudflare zone (zone tag). Cloudflare extension. - `x_zone_name: Optional[str]` The display name of the Cloudflare zone. Cloudflare extension. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) usages = client.organizations.billing.usage.get( organization_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(usages) ``` #### Response ```json { "errors": [ { "message": "message", "code": 0 } ], "messages": [ { "message": "message", "code": 0 } ], "result": [ { "BillingAccountId": "023e105f4ecef8ad9ca31a8372d0c353", "BillingAccountName": "My Account", "ChargeCategory": "Usage", "ChargeDescription": "Workers Standard Requests — daily usage", "ChargeFrequency": "Usage-Based", "ChargePeriodEnd": "2025-05-02T00:00:00Z", "ChargePeriodStart": "2025-05-01T00:00:00Z", "ConsumedQuantity": 150000, "ConsumedUnit": "Requests", "HostProviderName": "Cloudflare", "InvoiceIssuerName": "Cloudflare", "ServiceProviderName": "Cloudflare", "x_BillableMetricName": "Workers Standard Requests", "BilledCost": 0, "BillingCurrency": "USD", "BillingPeriodEnd": "2025-06-01T00:00:00Z", "BillingPeriodStart": "2025-05-01T00:00:00Z", "ChargeClass": "Correction", "ContractedCost": 0.75, "ContractedUnitPrice": 0.000005, "EffectiveCost": 0, "ListCost": 0.75, "ListUnitPrice": 0.000005, "PricingQuantity": 150000, "PricingUnit": "Requests", "RegionId": "EEUR", "RegionName": "Eastern Europe", "SubAccountId": "c9bd752d-9ca8-411d-b804-be44a758057f", "SubAccountName": "My Subscription", "x_BillableMetricId": "workers_standard_requests", "x_ProductFamilyName": "Workers", "x_ZoneId": "023e105f4ecef8ad9ca31a8372d0c353", "x_ZoneName": "example.com" } ], "success": true } ``` ## Domain Types ### Usage Get Response - `List[UsageGetResponseItem]` Contains the array of cost and usage records. - `billing_account_id: str` Public identifier of the Cloudflare account (account tag). - `billing_account_name: str` Display name of the Cloudflare account. - `charge_category: Literal["Usage"]` Highest-level classification of a charge based on the nature of how it gets billed. Currently only "Usage" is supported. - `"Usage"` - `charge_description: str` Self-contained summary of the charge's purpose and price. - `charge_frequency: Literal["Usage-Based"]` Indicates how often a charge occurs. Currently only "Usage-Based" is supported. - `"Usage-Based"` - `charge_period_end: datetime` Exclusive end of the time interval during which the usage was consumed. - `charge_period_start: datetime` Inclusive start of the time interval during which the usage was consumed. - `consumed_quantity: float` Measured usage amount within the charge period. Reflects raw metered consumption before pricing transformations. - `consumed_unit: str` Unit of measure for the consumed quantity (e.g., "GB", "Requests", "vCPU-Hours"). - `host_provider_name: str` Name of the entity providing the underlying infrastructure or platform. - `invoice_issuer_name: str` Name of the entity responsible for invoicing for the services consumed. - `service_provider_name: str` Name of the entity that made the services available for purchase. - `x_billable_metric_name: str` The display name of the billable metric. Cloudflare extension; replaces FOCUS SkuMeter. - `billed_cost: Optional[float]` A charge serving as the basis for invoicing, inclusive of all reduced rates and discounts while excluding the amortization of upfront charges (one-time or recurring). - `billing_currency: Optional[str]` Currency that a charge was billed in (ISO 4217). - `billing_period_end: Optional[datetime]` Exclusive end of the billing cycle that contains this usage record. - `billing_period_start: Optional[datetime]` Inclusive start of the billing cycle that contains this usage record. - `charge_class: Optional[Literal["Correction"]]` Indicates whether the row represents a correction to one or more charges invoiced in a previous billing period. - `"Correction"` - `contracted_cost: Optional[float]` Cost calculated by multiplying ContractedUnitPrice and the corresponding PricingQuantity. - `contracted_unit_price: Optional[float]` The agreed-upon unit price for a single PricingUnit of the associated billable metric, inclusive of negotiated discounts, if present, while excluding any other discounts. - `effective_cost: Optional[float]` The amortized cost of the charge after applying all reduced rates, discounts, and the applicable portion of relevant, prepaid purchases (one-time or recurring) that covered the charge. - `list_cost: Optional[float]` Cost calculated by multiplying ListUnitPrice and the corresponding PricingQuantity. - `list_unit_price: Optional[float]` Suggested provider-published unit price for a single PricingUnit of the associated billable metric, exclusive of any discounts. - `pricing_quantity: Optional[float]` Volume of a given service used or purchased, based on the PricingUnit. - `pricing_unit: Optional[str]` Provider-specified measurement unit for determining unit prices, indicating how the provider rates measured usage after applying pricing rules like block pricing. - `region_id: Optional[str]` Provider-assigned identifier for an isolated geographic area where a service is provided. - `region_name: Optional[str]` Name of an isolated geographic area where a service is provided. - `sub_account_id: Optional[str]` Unique identifier assigned to a grouping of services. For Cloudflare, this is the subscription or contract ID. - `sub_account_name: Optional[str]` Name assigned to a grouping of services. For Cloudflare, this is the subscription or contract display name. - `x_billable_metric_id: Optional[str]` The unique identifier for the billable metric in the Cloudflare catalog. Cloudflare extension; replaces FOCUS SkuId. - `x_product_family_name: Optional[str]` The product family the charge belongs to (e.g., "R2", "Workers"). Cloudflare extension; replaces FOCUS ServiceName. - `x_zone_id: Optional[str]` The identifier for the Cloudflare zone (zone tag). Cloudflare extension. - `x_zone_name: Optional[str]` The display name of the Cloudflare zone. Cloudflare extension.