Skip to main content
Update an existing usage entry
curl --request PATCH \
  --url https://api.salesbricks.com/api/v2/usage \
  --header 'Content-Type: application/json' \
  --header 'X-SALESBRICKS-KEY: <api-key>' \
  --data '{
  "transaction_id": "12345",
  "value": 123,
  "count": 123,
  "properties": {
    "source": "api",
    "notes": "Updated notes",
    "region": "US"
  }
}'
{
  "message": "Usage entry updated successfully."
}
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
header
required

Use your Salesbricks API key to authenticate requests.

Body

application/json
transaction_id
string

The unique identifier for this usage entry transaction.

Example:

"12345"

value
integer

The new value to set for the gauge (if applicable).

count
integer

The new count to increment the counter by (if applicable).

properties
object

New or updated properties for the usage entry.

Example:
{
"source": "api",
"notes": "Updated notes",
"region": "US"
}

Response

Usage entry updated successfully.

message
string
Example:

"Usage entry updated successfully."