Skip to main content
POST
/
api
/
v1
/
usage
JavaScript
import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const response = await client.v1.usage.report({
  usages: [
    {
      customerId: 'customerId',
      featureId: 'featureId',
      value: -9007199254740991,
    },
  ],
});

console.log(response.data);
{
  "data": [
    {
      "id": "<string>",
      "value": -9007199254740990,
      "timestamp": "2023-11-07T05:31:56Z",
      "featureId": "<string>",
      "customerId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "currentUsage": 123,
      "usagePeriodStart": "2023-11-07T05:31:56Z",
      "usagePeriodEnd": "2023-11-07T05:31:56Z",
      "nextResetDate": "2023-11-07T05:31:56Z",
      "resourceId": "<string>"
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Server API Key

Headers

​
X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

​
X-ENVIRONMENT-ID
string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Body

application/json

Report usage for metered features. Batch up to 100 records.

​
usages
UsageRecord · object[]
required

A list of usage reports to be submitted in bulk

Required array length: 1 - 100 elements

Response

The recorded usage measurement objects.

Response containing reported usage measurements with current usage values, period information, and reset dates for each measurement.

​
data
UsageMeasurement · object[]
required

Array of usage measurements with current values and period info