Skip to main content
POST
/
companies
/
{company_id}
/
subscriptions
/
{id}
/
current_period_usage
Get Subscription Usage for Current Period
curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/subscriptions/{id}/current_period_usage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "item_id": "<string>"
}
'
{
  "additional_available_credit_units": 123,
  "used_count_by_metric_id": {}
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

​
company_id
string
required

The company ID with the prefix 'cmp_'.

​
id
string
required

The resource ID

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

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