GET
/
v1
/
events
/
{id}
Typescript (SDK)
import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.events.get({
    id: "<value>",
  });

  console.log(result);
}

run();
{
  "id": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "customer_id": "<string>",
  "customer": {
    "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "external_id": "usr_1337",
    "email": "customer@example.com",
    "email_verified": true,
    "name": "John Doe",
    "billing_address": {
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "US"
    },
    "tax_id": [
      "911144442",
      "us_ein"
    ],
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    "deleted_at": "2023-11-07T05:31:56Z",
    "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"
  },
  "external_customer_id": "<string>",
  "source": "<string>",
  "name": "<string>",
  "metadata": {
    "meter_id": "<string>",
    "units": 123,
    "rollover": true
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid4>
required

The event ID.

Response

Successful Response

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

​
id
string<uuid4>
required

The ID of the object.

​
timestamp
string<date-time>
required

The timestamp of the event.

​
organization_id
string<uuid4>
required

The ID of the organization owning the event.

Examples:

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

​
customer_id
string<uuid4> | null
required

ID of the customer in your Polar organization associated with the event.

​
customer
object | null
required

The customer associated with the event. A customer in an organization.

​
external_customer_id
string | null
required

ID of the customer in your system associated with the event.

​
source
string
required

The source of the event. system events are created by Polar. user events are the one you create through our ingestion API.

Allowed value: "system"
​
name
string
required

The name of the event.

Allowed value: "meter.credited"
​
metadata
object
required