Skip to main content
POST
/
meter-event
Record usage event
curl --request POST \
  --url https://demo.onlinebillingform.com/api/v2/meter-event \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": 123,
  "order_id": 123,
  "name": "<string>",
  "qty": 2,
  "payload": {}
}
'
{
  "success": true,
  "data": {
    "id": 481,
    "metric": "Bandwidth",
    "qty": 25,
    "unit_price": "0.050000",
    "billable_qty": 5,
    "free_qty": 20,
    "amount": 0.25,
    "usage": {
      "used": 105,
      "remaining_free": 0,
      "remaining_free_percent": 0,
      "overage_qty": 5,
      "billable_qty": 5,
      "current_unbilled_amount": "0.2500",
      "threshold": {
        "level": "warning",
        "threshold": 10,
        "message": "Free usage is below 10%."
      }
    },
    "meter": {
      "id": 7,
      "name": "Bandwidth",
      "unit_label": "GB",
      "included_allowance": 100,
      "unit_price": "0.050000",
      "usage": {
        "used": 105,
        "remaining_free": 0,
        "remaining_free_percent": 0,
        "overage_qty": 5,
        "billable_qty": 5,
        "current_unbilled_amount": "0.2500",
        "threshold": {
          "level": "warning",
          "threshold": 10,
          "message": "Free usage is below 10%."
        }
      }
    },
    "data": {
      "resource_id": "server-123",
      "source": "provisioning-system"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Use Authorization: Bearer <live_api_key>.

Body

​
customer_id
integer
required

Customer ID that owns the order.

​
order_id
integer
required

Order ID to record usage against.

​
name
string
required

Usage metric name configured on the order package.

​
qty
number
required

Usage quantity to add. Must be at least 1.

Required range: x >= 1
​
payload

Optional metadata stored with the usage event. Non-object values are wrapped by the API under value.

Response

Usage event recorded

​
success
boolean
​
data
object