Sign in
latestOpenAPI 3.1.02026-08-2211754502.4 KB

76cfbed5eb40

Usage

Record usage event

Records bill-in-arrears usage for a configured package usage metric on a customer order. The authenticated API key must own the order, and name must match a usage metric configured on the order's package.

post/meter-event

Request body

customer_idinteger required

Customer ID that owns the order.

order_idinteger required

Order ID to record usage against.

namestring required

Usage metric name configured on the order package.

qtynumber required

Usage quantity to add. Must be at least 1.

Response

Usage event recorded

successtrue

Example response

{
  "data": {
    "usage": {
      "threshold": {
        "level": "warning",
        "message": "Free usage is below 10%."
      }
    },
    "meter": {
      "usage": {
        "threshold": {
          "level": "warning",
          "message": "Free usage is below 10%."
        }
      }
    }
  }
}