Skip to main content
GET
/
v0
/
billableMetrics
/
{id}
/
events
List Meter Events
curl --request GET \
  --url https://api.paygentic.io/v0/billableMetrics/{id}/events \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "billableMetricId": "<string>",
  "events": [
    {
      "id": "<string>",
      "object": "meterEvent",
      "type": "<string>",
      "source": "<string>",
      "subject": "<string>",
      "time": "2023-11-07T05:31:56Z",
      "idempotencyKey": "<string>",
      "data": {}
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

id
string
required

Unique identifier for a billable metric

Pattern: ^bm_[a-zA-Z0-9]+$

Query Parameters

from
string<date-time>
required

Start of query window (ISO 8601)

to
string<date-time>
required

End of query window (ISO 8601)

subject
string

Filter by subject (typically the customer/user ID)

limit
integer
default:20

Maximum number of events to return

Required range: 1 <= x <= 200
offset
integer
default:0

Number of events to skip

Required range: x >= 0

Response

Raw events list

object
enum<string>
default:list
required
Available options:
list
billableMetricId
string
required

Unique identifier for a billable metric

Pattern: ^bm_[a-zA-Z0-9]+$
events
object[]
required
pagination
object
required

Offset-based pagination response.