Sign in

v20

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-214885191.3 KB
Usage

Record a usage event

Records a usage event into the Usage timeseries collection.

post/v1/sdk/usages

Request body

actionType'transaction' | 'api_call' | 'hour' | 'email' | 'storage' | 'custom'
customerRefstring required
descriptionstring
durationnumber
errorMessagestring
idempotencyKeystring
metadataobject required
outcome'success' | 'paywall' | 'fail'
productRefstring
purchaseRefstring
timestampstring date-time required
unitsinteger

Response

Usage recorded successfully

referencestring required
successboolean required

Example response

{
  "creditDebit": {
    "amount": 10,
    "autoRecharge": {
      "triggered": true
    },
    "unitsRemaining": 99
  },
  "reference": "usage_A1B2C3D4",
  "success": true
}