Skip to main content
GET
/
v1
/
events
/
Go (SDK)
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.CreateEventsListQueryParamOrganizationIDFilterStr(
            "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": [
    {
      "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": "[email protected]",
        "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>",
      "child_count": 0,
      "parent_id": "<string>",
      "source": "<string>",
      "name": "<string>",
      "metadata": {
        "meter_id": "<string>",
        "units": 123,
        "rollover": true
      }
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Authorizations

Authorization
string
header
required

Query Parameters

filter
string | null
start_timestamp
string<date-time> | null
end_timestamp
string<date-time> | null
organization_id
Examples:
customer_id
external_customer_id
meter_id
string<uuid4> | null
name
source
Available options:
system,
user
query
string | null
parent_id
string<uuid4> | null
hierarchical
boolean
default:false
page
integer
default:1
Required range: x > 0
limit
integer
default:10
Required range: x > 0
sorting
enum<string>[] | null
metadata
object | null

Response

items
Items · array
required
  • MeterCreditEvent
  • MeterResetEvent
  • BenefitGrantedEvent
  • BenefitCycledEvent
  • BenefitUpdatedEvent
  • BenefitRevokedEvent
  • SubscriptionCycledEvent
  • SubscriptionRevokedEvent
  • SubscriptionProductUpdatedEvent
  • SubscriptionSeatsUpdatedEvent
  • OrderPaidEvent
  • OrderRefundedEvent
  • CustomerCreatedEvent
  • CustomerUpdatedEvent
  • CustomerDeletedEvent
  • UserEvent
pagination
object
required