Query for usage/metered data

GET 
/api/v3/usage

Available query parameter values for filtering:

• line_item_id - associated subscription line
• external_key - external key for usage/metered data point
• from - from date
• to - to date

Request

Query Parameters

where string

line_item_id:EQUALS:581

order string

line_item_id:ASC

limit string

2

offset string

8

Responses

200

Object was fetched successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable

response

object[]

Array [

usage_history_id integer

Usage History ID #

line_item_id string

Line Item ID that the usage is for

usage_value string

Usage value

type string

Usage type (default "add", other options are "add", "max", "lat", "pia", "pas", "dlt")

from string

Starting date/time for the usage period

to string

Ending date/time for the usage period

external_key string

External key value

custom_1 string

Custom field 1

custom_2 string

Custom field 2

custom_3 string

Custom field 3

custom_4 string

Custom field 4

custom_5 string

Custom field 5

custom_6 string

Custom field 6

custom_7 string

Custom field 7

custom_8 string

Custom field 8

custom_9 string

Custom field 9

custom_10 string

Custom field 10

custom_11 string

Custom field 11

custom_12 string

Custom field 12

custom_13 string

Custom field 13

custom_14 string

Custom field 14

custom_15 string

Custom field 15

custom_16 string

Custom field 16

custom_17 string

Custom field 17

custom_18 string

Custom field 18

custom_19 string

Custom field 19

custom_20 string

Custom field 20

]

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": [
    {
      "usage_history_id": 0,
      "line_item_id": "string",
      "usage_value": "string",
      "type": "string",
      "from": "string",
      "to": "string",
      "external_key": "string",
      "custom_1": "string",
      "custom_2": "string",
      "custom_3": "string",
      "custom_4": "string",
      "custom_5": "string",
      "custom_6": "string",
      "custom_7": "string",
      "custom_8": "string",
      "custom_9": "string",
      "custom_10": "string",
      "custom_11": "string",
      "custom_12": "string",
      "custom_13": "string",
      "custom_14": "string",
      "custom_15": "string",
      "custom_16": "string",
      "custom_17": "string",
      "custom_18": "string",
      "custom_19": "string",
      "custom_20": "string"
    }
  ]
}

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "details": {},
  "response": [
    {
      "usage_history_id": 14,
      "external_key": null,
      "usage_value": 1,
      "custom_1": "test",
      "custom_2": "test2",
      "custom_3": null,
      "custom_4": null,
      "custom_5": null,
      "custom_6": null,
      "custom_7": null,
      "custom_8": null,
      "custom_9": null,
      "custom_10": null,
      "custom_11": null,
      "custom_12": null,
      "custom_13": null,
      "custom_14": null,
      "custom_15": null,
      "custom_16": null,
      "custom_17": null,
      "custom_18": null,
      "custom_19": null,
      "custom_20": null,
      "line_item_id": 581,
      "from": "2024-05-04 00:00:00",
      "to": "2024-05-04 00:00:00"
    },
    {
      "usage_history_id": 15,
      "external_key": null,
      "usage_value": 3,
      "custom_1": "test",
      "custom_2": "test2",
      "custom_3": null,
      "custom_4": null,
      "custom_5": null,
      "custom_6": null,
      "custom_7": null,
      "custom_8": null,
      "custom_9": null,
      "custom_10": null,
      "custom_11": null,
      "custom_12": null,
      "custom_13": null,
      "custom_14": null,
      "custom_15": null,
      "custom_16": null,
      "custom_17": null,
      "custom_18": null,
      "custom_19": null,
      "custom_20": null,
      "line_item_id": 629,
      "from": "2024-05-05 00:00:00",
      "to": "2024-05-05 00:00:00"
    }
  ]
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

Loading...