Skip to main content
POST
Get Subscription Usage for Current Period

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Scopes

Path Parameters

id
string
required

The resource ID

company_id
string
required

The company ID with the prefix 'cmp_'.

Body

application/json
item_id
string
required

The specific item for which usage is being requested

Response

200 - application/json

OK

additional_available_credit_units
number

The total credits available for the billable item

used_count_by_metric_id
object | null

The total usage of metrics for the billable item in the current billing period of the subscription