List Events

GET

events

package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Events.List(ctx, operations.EventsListRequest{
        OrganizationID: polargo.Pointer(operations.CreateEventsListQueryParamOrganizationIDFilterArrayOfStr(
            []string{
                "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
            },
        )),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.ListResourceEvent != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

{
  "items": [
    {
      "metadata": {},
      "id": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "source": "system",
      "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=blank"
      },
      "external_customer_id": "<string>"
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

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 | null

Filter events after this timestamp.

end_timestamp

string | null

Filter events before this timestamp.

organization_id

Filter by organization ID.

Example:

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

customer_id

Filter by customer ID.

external_customer_id

Filter by external customer ID.

meter_id

string | null

Filter by a meter filter clause.

name

Filter by event name.

source

Filter by event source.

Available options:

system,

user

page

integer

default:1

Page number, defaults to 1.

Required range: x > 0

limit

integer

default:10

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

Required range: x > 0

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

object | null

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

Response

200

application/json

Successful Response

items

object[]

required

items.metadata

object

required

items.id

string

required

The ID of the object.

items.timestamp

string

required

The timestamp of the event.

items.name

string

required

The name of the event.

items.source

enum<string>

required

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

Available options:

system,

user

items.organization_id

string

required

The ID of the organization owning the event.

Example:

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

items.customer_id

string | null

required

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

items.customer

object | null

required

The customer associated with the event.

items.customer.id

string

required

The ID of the customer.

Example:

"992fae2a-2a17-4b7a-8d9e-e287cf90131b"

items.customer.created_at

string

required

Creation timestamp of the object.

items.customer.modified_at

string | null

required

Last modification timestamp of the object.

items.customer.metadata

object

required

items.customer.external_id

string | null

required

The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.

Example:

"usr_1337"

items.customer.email

string

required

The email address of the customer. This must be unique within the organization.

Example:

"customer@example.com"

items.customer.email_verified

boolean

required

Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address.

Example:

true

items.customer.name

string | null

required

The name of the customer.

Example:

"John Doe"

items.customer.billing_address

object | null

required

items.customer.tax_id

any[] | null

required

Example:

["911144442", "us_ein"]

items.customer.organization_id

string

required

The ID of the organization owning the customer.

Example:

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

items.customer.deleted_at

string | null

required

Timestamp for when the customer was soft deleted.

items.customer.avatar_url

string

required

Example:

"https://www.gravatar.com/avatar/xxx?d=blank"

items.external_customer_id

string | null

required

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

pagination

object

required

Was this page helpful?

Get Event

Create Meter

package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Events.List(ctx, operations.EventsListRequest{
        OrganizationID: polargo.Pointer(operations.CreateEventsListQueryParamOrganizationIDFilterArrayOfStr(
            []string{
                "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
            },
        )),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.ListResourceEvent != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

{
  "items": [
    {
      "metadata": {},
      "id": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "source": "system",
      "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=blank"
      },
      "external_customer_id": "<string>"
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Core API

Customer Portal API

Webhook Events

OAuth 2.0 API

Authorizations

Query Parameters

Response