Storing usage/metered data

POST 
/api/v3/usage

Request

application/json

Body

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")

options array

An array of usage options

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

Responses

201

Object was created successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable

response

object

id integer

Example (from schema)

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

Example 1

{
  "code": 201,
  "status": "OK",
  "message": "",
  "details": {},
  "response": {
    "id": 1234
  }
}

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...