Usage
Submit a usage entry
Usage
Submit a usage entry
Use this API to set either a prorated gauge or increment a final value counter for a customer.
To use this endpoint, ensure that you are using the v2/usage/ API endpoint:
https://api.salesbricks.com/api/v2/usage/
Authorizations
X-SALESBRICKS-KEY
string
headerrequiredUse your Salesbricks API key to authenticate requests.
Body
application/json
transaction_id
string
The unique identifier for this usage entry transaction.
subscription_id
string
The UUID of the Salesbricks subscription associated with the customer.
brick_id
string
The UUID of the associated Usage Brick.
value
integer
The value to set for the gauge (required if setting a gauge).
count
integer
The amount to increment the counter by (required if incrementing a counter).
properties
object
Additional properties for the usage entry.
time
string
The timestamp indicating when the operation occurs in ISO 8601 format.
Response
201 - application/json
message
string