BEbeeble
portal

Get Usage

Changed on

Recorded Product API credits by usage date, inclusive UTC calendar dates.

Product-job submissions only; legacy SwitchX USD/credits and web spend are excluded. A partial response is a bounded subset, never a period total. Refunds reflect current confirmed refunds of those charges, not refund transactions that occurred during the selected dates. Organization admins also get by_team, keyed by the team each job ran under, and may filter team_id by a team ID, or none for jobs without a team.

get/v1/portal/organizations/{org_id}/usage

Request

  • Base URL
    https://api.beeble.ai
  • Auth
    HTTP bearer

Path parameters

org_idstring required

Query parameters

start_datestring date nullable
end_datestring date nullable
productstring nullable
model_idstring nullable
api_key_idstring nullable
user_idstring nullable
team_idstring nullable

Headers

authorizationstring

Response

Successful Response

gross_creditsinteger
refunded_creditsinteger
net_creditsinteger
organization_idstring nullable
scope'organization' | 'member' | 'personal' required
start_datestring date required
end_datestring date required
usage_recordsinteger
is_partialboolean
scanned_recordsinteger
max_recordsinteger required

Changes

  • 0c4362818fd3Revision changes
    • info

      added the new optional query request parameter team_id

    • info

      added the optional property to the response with the status

  • a9ab2752bcd8Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      response property organization_id list-of-types was widened by adding types null to media type application/json of response 200

    • warning

      added the new personal enum value to the response property for the response status