Skip to content

Usage Object



id
string
REQUIRED · 

Unique identifier for the usage.

product
object

The product associated with the usage.

id
string
REQUIRED · 

Unique identifier for the product.

name
string

Name of the product.

metric_name
string

Name of the metric being charged for

resources
object[]
id
string

Unique identifier for the resource.

name
string

Name of the resource.

workspace
object

The resource is present in this workspace.

id
string

Unique identifier for the workspace.

name
string

Name of the workspace.

organization
object

The organization associated with the usage.

id
string
REQUIRED · 

Unique identifier for the organization.

name
string

Name of the organization.

charges
object[]

The amounts charged for the usage.

amount
number

The amount charged for the usage.

currency
string

The currency in which the charge is made.

type
string

The type of charge.

All possible enum values:
  • total
  • on_demand
  • committed
usage
object

The usage data for the product.

start_date
string · date-time

The start date for the usage data.

end_date
string · date-time

The end date for the usage data.

created_at
string · date-time

Date and time when the usage data metric was created.

updated_at
string · date-time

Date and time when the usage data metric was last updated.

remote_data
object

Raw data returned from the remote API call.