Get Organization Usage Handler

GET 
/v1/organization/:organization_id_or_slug/usage2

Fetches the organization usage for the given period.

Request

Path Parameters

organization_id_or_slug Organization Id Or Slugrequired

Query Parameters

billing_period any

The exact start date of the period to fetch usage for.

offset_number Offset Number

Default value: 0

limit any

Responses

200

Successful Response

application/json

Schema

Schema

plan_type Plan Type (string)required

billing_period

object

required

anyOf

MOD1

string

text_tokens

object

required

used Used (integer)

Default value: 0

total units used

offered

object

units included in plan

anyOf

MOD1

integer

unit_price

object

price per unit of usage over included amount

anyOf

MOD1

number

unit_price_str

object

exact price per unit as a string

anyOf

MOD1

string

billable

object

billable overage price in USD

anyOf

MOD1

string

image_embeddings

object

required

used Used (integer)

Default value: 0

total units used

offered

object

units included in plan

anyOf

MOD1

integer

unit_price

object

price per unit of usage over included amount

anyOf

MOD1

number

unit_price_str

object

exact price per unit as a string

anyOf

MOD1

string

billable

object

billable overage price in USD

anyOf

MOD1

string

seats

object

required

used Used (integer)

Default value: 0

total units used

offered

object

units included in plan

anyOf

MOD1

integer

unit_price

object

price per unit of usage over included amount

anyOf

MOD1

number

unit_price_str

object

exact price per unit as a string

anyOf

MOD1

string

billable

object

billable overage price in USD

anyOf

MOD1

string

storage

object

required

used Used (integer)

Default value: 0

total units used

offered

object

units included in plan

anyOf

MOD1

integer

unit_price

object

price per unit of usage over included amount

anyOf

MOD1

number

unit_price_str

object

exact price per unit as a string

anyOf

MOD1

string

billable

object

billable overage price in USD

anyOf

MOD1

string

Example (from schema)

{
  "plan_type": "string",
  "billing_period": "2024-07-29T15:51:28.071Z",
  "text_tokens": {
    "used": 0,
    "offered": 0,
    "unit_price": 0,
    "unit_price_str": "string",
    "billable": "string"
  },
  "image_embeddings": {
    "used": 0,
    "offered": 0,
    "unit_price": 0,
    "unit_price_str": "string",
    "billable": "string"
  },
  "seats": {
    "used": 0,
    "offered": 0,
    "unit_price": 0,
    "unit_price_str": "string",
    "billable": "string"
  },
  "storage": {
    "used": 0,
    "offered": 0,
    "unit_price": 0,
    "unit_price_str": "string",
    "billable": "string"
  }
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...