Skip to main content
GET
Go (SDK)

Authorizations

Authorization
string
header
required

You can generate an Organization Access Token from your organization's settings.

Query Parameters

filter
string | null

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

start_timestamp
string<date-time> | null

Filter events after this timestamp.

end_timestamp
string<date-time> | null

Filter events before this timestamp.

organization_id

Filter by organization ID. The organization ID.

Example:

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

customer_id

Filter by customer ID. The customer ID.

external_customer_id

Filter by external customer ID.

meter_id
string<uuid4> | null

Filter by a meter filter clause. The meter ID.

name

Filter by event name.

source

Filter by event source.

Available options:
system,
user
query
string | null

Query to filter events.

parent_id
string<uuid4> | null

When combined with depth, use this event as the anchor instead of root events. The event ID.

depth
integer | null

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

Page number, defaults to 1.

limit
integer
default:10

Size of a page, defaults to 10. Maximum is 100.

sorting
enum<string>[] | null

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

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

Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.

Response

Successful Response

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

An event created by Polar when credits are added to a customer meter.

pagination
Pagination · object
required