# List events

> For the complete machine-readable documentation index, see [llms.txt](https://apidocs.chargebee.com/llms.txt).


[Eventually Consistent](/docs/api/v2/pcv-1/read-consistency)

Retrieves list of events.

## Sample Request

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/events \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=2 \
     --data-urlencode "event_type[in]"='["subscription_created","customer_created"]'
```

#### .NET

```dotnet
using ChargeBee.Api;
using ChargeBee.Models;
using ChargeBee.Models.Enums;
using Newtonsoft.Json.Linq;

ApiConfig.Configure("{site}","{site_api_key}");
ListResult result = Event.List()
		.Limit(2)
		.EventType().In(EventTypeEnum.SubscriptionCreated, EventTypeEnum.CustomerCreated)
		.Request();

foreach (var listItem in result.List){
  Event @event = listItem.Event;
}
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    "github.com/chargebee/chargebee-go/v3/filter"
    eventAction "github.com/chargebee/chargebee-go/v3/actions/event"
    "github.com/chargebee/chargebee-go/v3/models/event"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := eventAction.List(&event.ListRequestParams{
        Limit : chargebee.Int32(2),
        EventType : &filter.EnumFilter{
            In : []interface{}{"subscription_created","customer_created"},
        },
    }).ListRequest()
    if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            Event := res.List[idx].Event
        }
    }
}
```

#### Go

```go
package main

import (
  "fmt"
  "github.com/chargebee/chargebee-go/v4"
)

func main() {
  config := &chargebee.ClientConfig{
    SiteName: "{site}",
    ApiKey: "{site_api_key}",
  }    
  client := chargebee.NewClient(config)
  req := &chargebee.EventListRequest{
    Limit : chargebee.Int32(2),
    EventType : &chargebee.EnumFilter{
        In : []interface{}{"subscription_created","customer_created"},
    },
}
  res, err := client.Event.List(req)
      if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            Event := res.List[idx].Event
        }
    }
}
```

#### Java

```java
import com.chargebee.*;
import com.chargebee.ListResult;
import com.chargebee.models.*;
import com.chargebee.models.enums.*;
import java.io.IOException;
import java.util.List;

public class Sample {

    public static void main(String args[]) throws IOException, Exception {
        Environment.configure("{site}", "{site_api_key}");
        ListResult result = Event.list()
            .limit(2)
            .eventType().in(EventType.SUBSCRIPTION_CREATED, EventType.CUSTOMER_CREATED)
            .request();

        for (ListResult.Entry entry : result) {
            Event event = entry.event();
        }
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.event.Event;
import com.chargebee.v4.models.event.params.EventListParams;
import com.chargebee.v4.models.event.responses.EventListResponse;
import java.util.List;

public class EventList {

    public static void main(String[] args) {
        ChargebeeClient client = ChargebeeClient.builder()
            .apiKey("{site_api_key}")
            .siteName("{site}")
            .build();

        EventListParams params = EventListParams.builder()
            .limit(2)
            .eventType()
            .in(EventListParams.EventType.SUBSCRIPTION_CREATED, EventListParams.EventType.CUSTOMER_CREATED)
            .build();

        EventListResponse response = client.events().list(params);
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

const chargebee = new Chargebee({
    site: "{site}",
    apiKey: "{site_api_key}",
});

try {
    const result = await chargebee.event.list({
        limit: 2,
        event_type: {
            in: ["subscription_created", "customer_created"]
        }
    });
    result.list.forEach((entry) => {
        console.log(entry);
        const event = entry.event;
    });
} catch (err) {
    console.log(err);
}
```

#### PHP

```php
<?php

require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
    "site" => "{site}",
    "apiKey" => "{site_api_key}",
]);
$result = $chargebee->event()->all([
    "limit" => 2,
    "event_type" => [
        "in" => ["subscription_created", "customer_created"]
    ]
]);
foreach($result->list as $entry) {
    $event = $entry->event;
}
```

#### Python

```python
import chargebee
from chargebee import Chargebee, Filters

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
entries = cb_client.Event.list(
    cb_client.Event.ListParams(
        limit=2,
        event_type=Filters.EnumFilter(IN=[chargebee.EventType.SUBSCRIPTION_CREATED, chargebee.EventType.CUSTOMER_CREATED])
    )
)
for entry in entries.list:
    event = entry.event
```

#### Ruby

```ruby
require 'chargebee'

ChargeBee.configure(:site => "{site}",
  :api_key => "{site_api_key}")

list = ChargeBee::Event.list({
  :limit => 2,
  "event_type[in]" => "[\"subscription_created\",\"customer_created\"]"
})

list.each do |entry|
  event = entry.event
end
```

## Sample Response

```json
{
  "list": [
    {
      "event": {
        "api_version": "v2",
        "content": {
          "customer": {
            "allow_direct_debit": false,
            "auto_collection": "on",
            "card_status": "no_card",
            "created_at": 1517505957,
            "deleted": false,
            "excess_payments": 0,
            "id": "__test__KyVnHhSBWm4Xv2rm",
            "net_term_days": 0,
            "object": "customer",
            "pii_cleared": "active",
            "preferred_currency_code": "USD",
            "promotional_credits": 0,
            "refundable_credits": 0,
            "resource_version": 1517505957000,
            "taxability": "taxable",
            "unbilled_charges": 0,
            "updated_at": 1517505957
          },
          "subscription": {
            "billing_period": 1,
            "billing_period_unit": "month",
            "created_at": 1517505957,
            "currency_code": "USD",
            "customer_id": "__test__KyVnHhSBWm4Xv2rm",
            "deleted": false,
            "due_invoices_count": 0,
            "has_scheduled_changes": false,
            "id": "__test__KyVnHhSBWm4Xv2rm",
            "next_billing_at": 1518801957,
            "object": "subscription",
            "plan_amount": 1500,
            "plan_free_quantity": 0,
            "plan_id": "plan1",
            "plan_quantity": 1,
            "plan_unit_price": 1500,
            "resource_version": 1517505957000,
            "started_at": 1517505957,
            "status": "in_trial",
            "trial_end": 1518801957,
            "trial_start": 1517505957,
            "updated_at": 1517505957
          }
        },
        "event_type": "subscription_created",
        "id": "ev___test__KyVnHhSBWm4am2rp",
        "object": "event",
        "occurred_at": 1517505957,
        "source": "api",
        "user": "full_access_key_v1",
        "webhook_status": "scheduled"
      }
    },
    {..}
  ]
}
```

## URL Format

**GET** https://[site].chargebee.com/api/v2/events

## Input Parameters

- `limit` (optional, integer, default=10, min=1, max=100)
  The number of resources to be returned.

- `offset` (optional, string, max chars=1000)
  Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set `offset` to the value of `next_offset` obtained in the previous iteration of the API call.

## Returns

- `next_offset` (optional, string, max chars=1000)
  This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.

- `event` (Event object)
  Resource object representing event