Get brick usage for a subscription
curl --request GET \
  --url https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/bricks/{brick_id}/usage \
  --header 'X-SALESBRICKS-KEY: <api-key>'
{
  "starts_at": "2023-11-07T05:31:56Z",
  "ends_at": "2023-11-07T05:31:56Z",
  "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "brick_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "brick_name": "<string>",
  "pre_commitment": 123,
  "used": 123,
  "remaining": 123,
  "unit": "<string>"
}

Authorizations

​
X-SALESBRICKS-KEY
string
header
required

API key for authentication

Path Parameters

​
brick_id
string
required
​
subscription_id
string
required

Query Parameters

​
currentPeriod
enum<string>

Set to '1' or 'true' to only return usage for the current period.

Available options:
1,
True,
true

Response

200 - application/json

The response is of type object.