Get usage details for an organization

GET 
/v1/providers/:provider_id/orgs/:org_id/usage

Returns the usage details for the specified period. The usage details will include all the billable metrics for the period.

Request

Path Parameters

provider_id stringrequired

Provider ID

org_id stringrequired

Organization ID

Query Parameters

starting_on stringrequired
RFC3339 formatted UTC midnight timestamp for starting period
Example: 2021-09-01T00:00:00Z
ending_before stringrequired
RFC3339 formatted UTC midnight timestamp for ending period
Example: 2021-09-01T00:00:00Z

Responses

200

OK

application/json

Schema

Schema

data

object[]

Array [

id stringrequired

Unique identifier for the usage metric

name stringrequired

Display name for customer invoice

description stringrequired

Human readable description of the usage metric

unit stringrequired

Unit of measurement

values

object[]

required

Array [

starting_on date-timerequired

RFC3339 formatted UTC timestamp for starting period

ending_before date-timerequired

RFC3339 formatted UTC timestamp for ending period

value doublerequired

Usage value for the period

]

]

Example (from schema)

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "unit": "string",
      "values": [
        {
          "starting_on": "2021-09-01T01:00:00Z",
          "ending_before": "2021-09-01T02:00:00Z",
          "value": 0
        }
      ]
    }
  ]
}

default

Unexpected error

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "string"
}

Loading...