POST
/
v1
/
c
/
usage
Record an Usage Event
curl --request POST \
  --url http://127.0.0.1:8080/v1/c/usage \
  --header 'Content-Type: application/json' \
  --header 'wb-key: <api-key>' \
  --data '{
  "customer_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
  "feature_slug": "<string>",
  "is_absolute": true,
  "metadata": {},
  "timestamp": "2023-11-07T05:31:56Z",
  "units": "<string>"
}'
This simplified, single-event usage reporting endpoint is suitable for logging individual events during testing. For production use, refer to the more powerful bulk endpoint designed to handle batches of multiple events.

Authorizations

​
wb-key
string
header
required

Body

application/json

Structure to report Usage for Usage-based features in a Contract Currently the only reporting strategy supported is additive, meaning that all reported usage units are summed for the billing period. This requires additional care from the reporter to ensure that no double-reporting takes place

​
customer_id
string
required

Unique identifier of an object. Consists of object class prefix and a UUID

Example:

"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"

​
feature_slug
string
required

Slug of the feature usage is reported for

​
units
string
required

Amount of units consumed since the last report

​
is_absolute
boolean | null

Setting this to true would discard all events with timestamp preceding this event, and will use this event's units as zero value for usage in the current billing period

​
metadata
object

Any metadata you wish to associate with the event Note that both keys and values can only be a string Additionally, please avoid escaping non-ascii symbols

​
timestamp
string<date-time> | null

Date for the Usage. When usage period is closed, all usage which timestamp falls between Usage period (Billing period) start and end will be summed.

Response

200

Recorded