OpenAPI::Client::OpenAI::Path::organization-costs(3)

NAME
OpenAPI::Client::OpenAI::Path::organization-costs - Documentation for the /organization/costs path.

DESCRIPTION
This document describes the API endpoint at "/organization/costs".

PATHS

  "GET /organization/costs"
Get costs details for the organization.

Operation ID

"usage-costs"

    $client->usage-costs( ... );

Parameters

•   "start_time" (in query) (Required) - Start time (Unix seconds) of the query time range, inclusive.

    Type: "integer"

•   "end_time" (in query) (Optional) - End time (Unix seconds) of the query time range, exclusive.

    Type: "integer"

•   "bucket_width" (in query) (Optional) - Width of each time bucket in response. Currently only `1d` is supported, default to `1d`.

    Type: "string"

    Allowed values: "1d"

    Default: "1d"

•   "project_ids" (in query) (Optional) - Return only costs for these projects.

    Type: "array"

•   "group_by" (in query) (Optional) - Group the costs by the specified fields. Support fields include `project_id`, `line_item` and any combination of them.

    Type: "array"

•   "limit" (in query) (Optional) - A limit on the number of buckets to be returned. Limit can range between 1 and 180, and the default is 7.

    Type: "integer"

    Default: 7

•   "page" (in query) (Optional) - A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.

    Type: "string"

Responses

Status Code: 200

Costs data retrieved successfully.

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

        {
           "data" : [
              {
                 "result" : [
                    null
                 ]
              }
           ]
        }

SEE ALSO
OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE
Copyright (C) 2023-2025 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.