Skip to main content
GET
List Events

Authorizations

Authorization
string
header
required

Authentication: You can generate a Personal Access Token from your settings.

Query Parameters

filter
string | null

Parameter: Filter events following filter clauses. JSON string following the same schema a meter filter clause.

start_timestamp
string<date-time> | null

Parameter: Filter events after this timestamp.

end_timestamp
string<date-time> | null

Parameter: Filter events before this timestamp.

organization_id

Return only records matching organization ID. Identifier of the organization.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

customer_id

Return only records matching customer ID. Identifier of the customer.

external_customer_id

Return only records matching external customer ID.

meter_id
string<uuid4> | null

Return only records matching a meter filter clause. Identifier of the meter.

name

Return only records matching event name.

source

Return only records matching event source.

Available options:
system,
user
query
string | null

Parameter: Query to filter events.

parent_id
string<uuid4> | null

Parameter: When combined with depth, use this event as the anchor instead of root events. Identifier of the event.

depth
integer | null

Parameter: Fetch descendants up to this depth. When set: 0=root events only, 1=roots+children, etc. Max 5. When not set, returns all events.

Required range: 0 <= x <= 5
page
integer
default:1

Results page to return. The first page is used by default.

limit
integer
default:10

Records returned per page. Defaults to 10 and accepts up to 100.

sorting
enum<string>[] | null

Sort rules applied from left to right. Prefix any rule with - to reverse it into descending order.

Available options:
timestamp,
-timestamp
metadata
MetadataQuery · object | null

Return only records matching metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.

Response

Request completed successfully

items
(MeterCreditEvent · object | MeterResetEvent · object | BenefitGrantedEvent · object | BenefitCycledEvent · object | BenefitUpdatedEvent · object | BenefitRevokedEvent · object | SubscriptionCreatedEvent · object | SubscriptionUpdatedEvent · object | SubscriptionCycledEvent · object | SubscriptionCanceledEvent · object | SubscriptionRevokedEvent · object | SubscriptionPastDueEvent · object | SubscriptionReactivatedEvent · object | SubscriptionUncanceledEvent · object | SubscriptionProductUpdatedEvent · object | SubscriptionSeatsUpdatedEvent · object | SubscriptionBillingPeriodUpdatedEvent · object | SubscriptionUpdateClearedEvent · object | OrderPaidEvent · object | OrderRefundedEvent · object | OrderVoidedEvent · object | CheckoutCreatedEvent · object | CustomerCreatedEvent · object | CustomerUpdatedEvent · object | CustomerDeletedEvent · object | BalanceOrderEvent · object | BalanceCreditOrderEvent · object | BalanceRefundEvent · object | BalanceRefundReversalEvent · object | BalanceDisputeEvent · object | BalanceDisputeReversalEvent · object | UserEvent · object)[]
required

Object representing event created by Ruba when credits are added to a customer meter.

pagination
Pagination · object
required