Usage
incrementCounter Mutation
Use this API to increment a Final value Brick
The incrementCounter
mutation is designed to increment the final value counter for a specific customer in Salesbricks.
To utilize this mutation, follow the authentication steps outlined in the Authentication guide, and ensure that you are using the Usage API Endpoint:
https://api.salesbricks.com/api/v1/usage
Mutation Parameters
timestamp
DateTime
requiredThe timestamp indicating when the counter incrementation occurs.
subscriptionId
String
requiredThe UUID of the Salesbricks subscription associated with the customer.
Obtain this value from the Public GraphQL API and store it against your internal account ID for the customer.
brickId
String
requiredThe UUID of the associated Usage Brick.
count
Int
requiredThe number to increment the counter by (e.g. 1
).
Response
success
Boolean
requiredThis response should be considered an empty response.
Important Notes
- To prevent duplicate requests and avoid over-charging customers, refer to the Idempotent Requests guide.
- Ensure accurate values for
timestamp
,subscriptionId
,brickId
, andcount
are included in the mutation for desired counter incrementation. - The
count
parameter cannot be negative, and should be discrete (not the total amount).