Skip to main content

Usage

The usage events that feed metered billing, with daily and monthly snapshots and a consolidated summary.

CommandHTTPDescription
usage listGET /v1/usageList usage records
usage createPOST /v1/usageReport usage (metered)
usage snapshots daily listGET /v1/usage/snapshots/dailyList daily usage snapshots
usage snapshots daily createPOST /v1/usage/snapshots/dailyCreate daily usage snapshots
usage snapshots monthly listGET /v1/usage/snapshots/monthlyList monthly usage snapshots
usage snapshots monthly createPOST /v1/usage/snapshots/monthlyCreate monthly usage snapshots
usage summary listGET /v1/usage/summaryUsage summary for the period

Examples​

--params carries query and path parameters (id, page, filters); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.

# List usage records
kobana billing usage list \
--fields "id,public_id,external_id,subscription_item_id,quantity"

# Report usage (metered)
kobana billing usage create

Next steps​