Skip to main content

Usage Commands

See Usage module docs for permissions and data model.

soat list-usage-meters​

List usage meters

  • Method: GET
  • Path: /api/v1/usage/meters

Usage​

soat list-usage-meters

Options​

--agent-id​

Filter by agent public ID

  • Source: query
  • Required: no
  • Type: string
--generation-id​

Filter by generation public ID

  • Source: query
  • Required: no
  • Type: string
--trace-id​

Filter by trace public ID

  • Source: query
  • Required: no
  • Type: string
--trigger-id​

Filter by the trigger that initiated the generation

  • Source: query
  • Required: no
  • Type: string
--action-id​

Filter by logical action id

  • Source: query
  • Required: no
  • Type: string
--limit​

—

  • Source: query
  • Required: no
  • Type: integer
  • Default: 50
--offset​

—

  • Source: query
  • Required: no
  • Type: integer
  • Default: 0

soat get-usage-receipt​

Get a generation's billing receipt

  • Method: GET
  • Path: /api/v1/usage/receipt

Usage​

soat get-usage-receipt --generation-id <string>

Options​

--generation-id​

Generation public ID

  • Source: query
  • Required: yes
  • Type: string

soat get-price-book​

Get the price book

  • Method: GET
  • Path: /api/v1/usage/prices

Usage​

soat get-price-book

Options​

This command has no options.

soat upsert-price-book​

Upsert price-book rows

  • Method: PUT
  • Path: /api/v1/usage/prices

Usage​

soat upsert-price-book --prices <array<object>>

Options​

--prices​

—

  • Source: body
  • Required: yes
  • Type: array<object>